Package clickTrainDetector.clickTrainAlgorithms.mht.mhtvar

Class CorrelationChi2

java.lang.Object
clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2Var
clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.CorrelationChi2
All Implemented Interfaces:
MHTChi2Var<PamDataUnit>, Cloneable
public class CorrelationChi2 extends SimpleChi2Var
Calculates the correlation value between subsequent clicks. Unlike amplitude and bearing used in the click train detector correlation is an absolute measure i.e. the absolute normalized difference between the current and second last detection in a train, rather than the change in difference between the last three clicks,.
Author:
Jamie Macaulay

  • Constructor Details

    • CorrelationChi2

      public CorrelationChi2()

  • Method Details

    • 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.

    • setSimpleChiVarParams

      public void setSimpleChiVarParams(SimpleChi2VarParams params)
      Description copied from class: SimpleChi2Var
      Set the chi2 params for the chi2variable.
      Overrides:
      setSimpleChiVarParams in class SimpleChi2Var

    • 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.

    • 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.

    • 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

    • 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.