analysis/org.eclipse.stem.util.analysis/src/org/eclipse/stem/util/analysis/ThresholdMeanSquareDifference.java

/**
 * 
 */
package org.eclipse.stem.util.analysis;
/*******************************************************************************
 * Copyright (c) 2007, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

import java.lang.reflect.InvocationTargetException;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.operation.IRunnableContext;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.stem.analysis.AnalysisFactory;
import org.eclipse.stem.analysis.ErrorResult;
import org.eclipse.stem.analysis.ThresholdErrorFunction;
import org.eclipse.stem.analysis.impl.AnalysisFactoryImpl;
import org.eclipse.stem.analysis.impl.ReferenceScenarioDataMapImpl;


   

/** 
 * this class computes the mean square difference between two scenarios as a function of time
 * 1. It only looks at locations which are COMMON to both scenarios
 * 2. The time series should be the same length. If they are not this will compare of a period equal to
 *    the SHORTEST of all the time series. 
 * 3. It only considers locations where infectious count is nonzero in one or the other - not interested in weighting regions with no disease.
 * 4. There is a threshold where we  ignore error if it's below the threshold. 
 * 
 * 
 * The simplified version only deals with absolute I comparison
 *
 */

public class ThresholdMeanSquareDifference {
	
	ReferenceScenarioDataMapImpl ref;
	ReferenceScenarioDataMapImpl data;
	ErrorResult result;
	
	static AnalysisFactory aFactory = new AnalysisFactoryImpl();
	static ThresholdErrorFunction errorFunction = aFactory.createThresholdErrorFunction();
	
	/**
	 * input
	 */
	//Map<String,List<Double>> commonInfectiousLocationsA = new HashMap<String,List<Double>>();
	//Map<String,List<Double>> commonInfectiousLocationsB = new HashMap<String,List<Double>>();
	
	
	
	
	/**
	 * Determines the MeanSquare difference between two scenario data sets over time each stored in a map
	 * @param scenarioMapA 
	 * @param scenarioMapB 
	 */
	public ThresholdMeanSquareDifference(ReferenceScenarioDataMapImpl scenarioMapA, ReferenceScenarioDataMapImpl scenarioMapB) {
		ref = scenarioMapA;
		data = scenarioMapB;
	}// constructor MeanSquareDifference
	
	
	
	
	/**
	 * solves for the Root MeanSquareDifference vs time
	 * using infectious data only for now
	 * 
	 * @param runnableContext Runnable context for progress indicator
	 * @return comparison time series as double[]
	 */
	public ErrorResult solve(IRunnableContext runnableContext) {
		final ThresholdMeanSquareDifference self = this;
		IRunnableWithProgress task = new IRunnableWithProgress() {
            public void run(IProgressMonitor progress) {
            	progress.beginTask("Solving...", 100);
            	
            	self.result = errorFunction.calculateError(self.ref, self.data);
            	progress.done();
            }
		};
		
		try {
			runnableContext.run(true, false, task);
		} catch(InterruptedException ie) {
			// Task is not interruptable
		} catch(InvocationTargetException ite) {
			// Task is not interruptable
		}
		return this.result;
	}// solve()

	
	
} // class ThresholdMeanSquareDifference