Package clickTrainDetector.clickTrainAlgorithms.mht

Class StandardMHTChi2Provider

java.lang.Object
clickTrainDetector.clickTrainAlgorithms.mht.StandardMHTChi2Provider
All Implemented Interfaces:
MHTChi2Provider<PamDataUnit>
public class StandardMHTChi2Provider extends Object implements MHTChi2Provider<PamDataUnit>
Standard MHT Chi2 provider manages the StandardMHTChi2 calculators associated with each possible track.

The standard chi^2 provider holds a list of subsequent ICI values between all clicks (on one channel). This is then used to calculate ICI value for all possible tracks quickly.

Author:
Jamie Macaulay

  • Constructor Details

  • Method Details

    • addDetection

      public void addDetection(PamDataUnit detection, int kcount)
      Description copied from interface: MHTChi2Provider
      Called every time a new detection is added.
      Specified by:
      addDetection in interface MHTChi2Provider<PamDataUnit>
      Parameters:
      detection - - detection
      kcount - - the total number of detection so far.

    • newMHTChi2

      public MHTChi2<PamDataUnit> newMHTChi2(MHTChi2<PamDataUnit> mhtChi2)
      Description copied from interface: MHTChi2Provider
      Create a new MHTChi2 instance. If mhtChi2 is non null then this is cloned with all current saved data and a new instance added.
      Specified by:
      newMHTChi2 in interface MHTChi2Provider<PamDataUnit>
      Parameters:
      mhtChi2 - - current instance of mhtChi2. Can be null.
      Returns:
      - new instance of MHTChi2

    • getIDIManager

      public IDIManager getIDIManager()
      Get the ICIManager. This handles calculation of inter click interval.
      Returns:
      the ICI manager.

    • getMHTKernelParams

      public MHTKernelParams getMHTKernelParams()
      Get the MHT Kernel parameters.
      Returns:
      the MHT kernel parameters.

    • getPamMHTChi2Params

      public StandardMHTChi2Params getPamMHTChi2Params()
      Get the parameters for the standard
      Returns:
      the standard MHT chi2 parameters.

    • setPamMHTChi2Params

      public void setPamMHTChi2Params(StandardMHTChi2Params pamMHTChi2Params)

    • getSettingsObject

      public MHTChi2Params getSettingsObject()
      GUI
      Specified by:
      getSettingsObject in interface MHTChi2Provider<PamDataUnit>

    • clear

      public void clear()
      Description copied from interface: MHTChi2Provider
      Called whenever the MHTKernel is reset and/or a completely new set of click trains are to be analysed.
      Specified by:
      clear in interface MHTChi2Provider<PamDataUnit>

    • getParams

      public StandardMHTChi2Params getParams()
      Get the chi2 parameters.
      Returns:
      returning the standard MHT chi2.

    • printSettings

      public void printSettings()
      Description copied from interface: MHTChi2Provider
      Print the settings to the console
      Specified by:
      printSettings in interface MHTChi2Provider<PamDataUnit>

    • setMHTParams

      public void setMHTParams(MHTParams mhtParams)
      Description copied from interface: MHTChi2Provider
      Set the MHT parameters fro the provider.
      Specified by:
      setMHTParams in interface MHTChi2Provider<PamDataUnit>
      Parameters:
      mhtParams - - the parameters to set.

    • clearKernelGarbage

      public void clearKernelGarbage(int newRefIndex)
      Description copied from interface: MHTChi2Provider
      Called whenever a clear Kernel Garbage command is sent to start at a new data unit. i.e. the kernel now starts from a new data unit and so some settings in the chi^2 may need to change.
      Specified by:
      clearKernelGarbage in interface MHTChi2Provider<PamDataUnit>
      Parameters:
      newRefIndex - - the index of the new reference data unit with respect to the old list.

    • getChi2Params

      public MHTChi2Params getChi2Params()
      Specified by:
      getChi2Params in interface MHTChi2Provider<PamDataUnit>
      Returns: