Package clickTrainDetector.clickTrainAlgorithms.mht.mhtvar

Class AmplitudeChi2

java.lang.Object

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2Var

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2VarDelta

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.AmplitudeChi2

All Implemented Interfaces:

MHTChi2Var<PamDataUnit>, Cloneable

public class AmplitudeChi2
extends SimpleChi2VarDelta

Chi^2 value for dB amplitude of tracks. Measures the chnage in track delta between subsequent detections.

Author:

Jamie Macaulay

Field Summary

Fields inherited from class clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2Var

settingsPane

Constructor Summary

Constructors

Constructor	Description
AmplitudeChi2()

Method Summary

Modifier and Type	Method	Description
double	calcDeltaChi2(double lastDelta, double newDelta, double timeDiff)	Calculate the chi2 for two different delta values.
double	getDiffValue(PamDataUnit pamDataUnit0, PamDataUnit pamDataUnit1)	Get the difference in value between two sequential data units.
double	getErrValue(PamDataUnit pamDataUnit0, PamDataUnit pamDataUnit1)	Get the error value between two sequential data units.
String	getName()	Get the name of the chi^2 variable.
MHTVarSettingsPane<SimpleChi2VarParams>	getSettingsPane()	Get the settings pane with controls to change MHTChi2Var settings
String	getUnits()	Get the data units for the MHTChi2 var.
void	setSettingsObject(Object object)	Set the settings object for saving the parameters.
void	setSimpleChiVarParams(SimpleChi2VarParams params)	Set the chi2 params for the chi2variable.

Methods inherited from class clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2VarDelta

updateChi2

Methods inherited from class clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2Var

calcChi2, calcChi2, clear, clone, getChi2, getError, getLastDataUnit, getMinCutValue, getSettingsObject, getSimpleChiVarParams, isDataBlockCompatible, setChi2, setError, setLastDataUnit

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AmplitudeChi2

public AmplitudeChi2()

Method Details

getName

public String getName()

Description copied from interface: MHTChi2Var

Get the name of the chi^2 variable.

Returns:

the name of the chi^2 variable.

getDiffValue

public double getDiffValue(PamDataUnit pamDataUnit0,
 PamDataUnit pamDataUnit1)

Description copied from class: SimpleChi2Var

Get the difference in value between two sequential data units. This is top of the chi2 equation.

Specified by:

getDiffValue in class SimpleChi2Var

Parameters:

pamDataUnit0 - - the first data unit.

pamDataUnit1 - - the second data unit.

Returns:

- the difference in selected variable between the two data units.

getErrValue

public double getErrValue(PamDataUnit pamDataUnit0,
 PamDataUnit pamDataUnit1)

Description copied from class: SimpleChi2Var

Get the error value between two sequential data units. This is denominator of the chi2 equation.

Specified by:

getErrValue in class SimpleChi2Var

Parameters:

pamDataUnit0 - - the first data unit.

pamDataUnit1 - - the second data unit.

Returns:

- the error between the difference

calcDeltaChi2

public double calcDeltaChi2(double lastDelta,
 double newDelta,
 double timeDiff)

Description copied from class: SimpleChi2VarDelta

Calculate the chi2 for two different delta values.

Overrides:

calcDeltaChi2 in class SimpleChi2VarDelta

Parameters:

lastDelta - - the first delta value

newDelta - - the second delta value

timeDiff - - the time difference for error calculation

Returns:

the chi^2 value.

getUnits

public String getUnits()

Description copied from interface: MHTChi2Var

Get the data units for the MHTChi2 var.

Returns:

the units.

setSimpleChiVarParams

public void setSimpleChiVarParams(SimpleChi2VarParams params)

Description copied from class: SimpleChi2Var

Set the chi2 params for the chi2variable.

Overrides:

setSimpleChiVarParams in class SimpleChi2Var

Parameters:

params -

setSettingsObject

public void setSettingsObject(Object object)

Description copied from interface: MHTChi2Var

Set the settings object for saving the parameters. This is only used for saving params.

Specified by:

setSettingsObject in interface MHTChi2Var<PamDataUnit>

Overrides:

setSettingsObject in class SimpleChi2Var

Parameters:

object - - the settings object.

getSettingsPane

public MHTVarSettingsPane<SimpleChi2VarParams> getSettingsPane()

Description copied from interface: MHTChi2Var

Get the settings pane with controls to change MHTChi2Var settings

Specified by:

getSettingsPane in interface MHTChi2Var<PamDataUnit>

Overrides:

getSettingsPane in class SimpleChi2Var

Returns:

the MHTChiVar specific settings pane.