Package clickTrainDetector.clickTrainAlgorithms.mht.mhtvar

Class BearingChi2

java.lang.Object

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2Var

clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.BearingChi2

All Implemented Interfaces:

MHTChi2Var<PamDataUnit>, Cloneable

public class BearingChi2
extends SimpleChi2Var

Chi2 value for changing bearing.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
BearingChi2()

Method Summary

Modifier and Type	Method	Description
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.
boolean	isDataBlockCompatible(PamDataBlock parentDataBlock)	Check whether a data block is compatible with this type of data unit.

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

calcChi2, clear, clone, getChi2, getError, getMinCutValue, getSettingsObject, getSimpleChiVarParams, setError, setSettingsObject, setSimpleChiVarParams, updateChi2

Methods inherited from class java.lang.Object

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

Constructor Details

BearingChi2

public BearingChi2()

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

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.

isDataBlockCompatible

public boolean isDataBlockCompatible(PamDataBlock parentDataBlock)

Description copied from interface: MHTChi2Var

Check whether a data block is compatible with this type of data unit.

Specified by:

isDataBlockCompatible in interface MHTChi2Var<PamDataUnit>

Overrides:

isDataBlockCompatible in class SimpleChi2Var

Parameters:

parentDataBlock - - the parent data block

Returns:

true if the data block is allowed

getUnits

public String getUnits()

Description copied from interface: MHTChi2Var

Get the data units for the MHTChi2 var.

Returns:

the units.