Package clickTrainDetector.clickTrainAlgorithms.mht

Interface MHTChi2<T>

All Known Implementing Classes:
StandardMHTChi2
public interface MHTChi2<T>
Any variable used by the MHT algorithm
Author:
Jamie Macaulay

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Calkled to indicate a reset and clear any variables/ reset iterators etc.
    void
    clearKernelGarbage(int newRefIndex)
    Resets to a new start data unit.
    MHTChi2<T>
    cloneMHTChi2()
    Clones the MHTChi2- it's vital that this copies the class completely as used to transfer the MHTChi2 algorithms to new branches.
    double
    getChi2()
    Calculate the chi2 value for a series of PAM detections.
    double
    getChi2(int pruneback)
    Get the chi2 value for n units back in the total time series.
    CTAlgorithmInfo
    getMHTChi2Info()
     
    int
    getNCoasts()
    Calculate the number of number of coasts.
    void
    printSettings()
    Print the settings for the algorithm
    void
    update(T detection0, TrackBitSet<T> trackBitSet, int kcount)
    Update the function with a new current data unit and the current track.

  • Method Details

    • getChi2

      double getChi2()
      Calculate the chi2 value for a series of PAM detections. The chi2 value indicates consistency of values within a detection train. e.g. it might calculate the consistency of inter-detection interval or amplitude values for a series of click trains.
      Returns:
      the chi2 value for the list of detection

    • getChi2

      double getChi2(int pruneback)
      Get the chi2 value for n units back in the total time series.
      Parameters:
      pruneback - - the units to go backwards- note this is the units included and not included in the track.
      Returns:
      the chi2 value for pruneback.

    • getNCoasts

      int getNCoasts()
      Calculate the number of number of coasts.
      Returns:
      the number of coasts.

    • update

      void update(T detection0, TrackBitSet<T> trackBitSet, int kcount)
      Update the function with a new current data unit and the current track.
      Parameters:
      detection0 - - the current detection. This corresponds to the last active index (kcount) in the bitset
      trackBitSet - - the bit set.
      the - number of data units represented sequentially in the BitSet.

    • cloneMHTChi2

      MHTChi2<T> cloneMHTChi2()
      Clones the MHTChi2- it's vital that this copies the class completely as used to transfer the MHTChi2 algorithms to new branches.

      Note: this must be a DEEP copy.

      Returns:
      clone of the current instance.

    • clear

      void clear()
      Calkled to indicate a reset and clear any variables/ reset iterators etc.

    • clearKernelGarbage

      void clearKernelGarbage(int newRefIndex)
      Resets to a new start 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.
      Parameters:
      newRefIndex - - the index of the new reference data unit with respect to the old list.

    • getMHTChi2Info

      CTAlgorithmInfo getMHTChi2Info()

    • printSettings

      void printSettings()
      Print the settings for the algorithm