Package clickTrainDetector.clickTrainAlgorithms.mht.mhtvar

Class PeakFrequencyChi2

java.lang.Object
clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.SimpleChi2Var
clickTrainDetector.clickTrainAlgorithms.mht.mhtvar.PeakFrequencyChi2
All Implemented Interfaces:
MHTChi2Var<PamDataUnit>, Cloneable
public class PeakFrequencyChi2 extends SimpleChi2Var
Peak frequency variable for click train detector. Correlation is very similar to this but peak frequency is more simple and perhaps a more stable measure.
Author:
Jamie Macaulay

  • Constructor Details

    • PeakFrequencyChi2

      public PeakFrequencyChi2()

  • 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

    • getUnits

      public String getUnits()
      Description copied from interface: MHTChi2Var
      Get the data units for the MHTChi2 var.
      Returns:
      the units.

    • 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

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