Package clickTrainDetector.clickTrainAlgorithms.mht

Class StandardMHTChi2Params

java.lang.Object
clickTrainDetector.clickTrainAlgorithms.mht.MHTChi2Params
clickTrainDetector.clickTrainAlgorithms.mht.StandardMHTChi2Params
All Implemented Interfaces:
Serializable, Cloneable, ManagedParameters
public class StandardMHTChi2Params extends MHTChi2Params implements Serializable, ManagedParameters
Parameters for the PamMHTChi2 class.

Note on penalty factors. Once the chi^2 is calculated based on the MHT track variables, then the track is given a series of penalties. A penalty in the variable name means that the higher the value the lower the higher the chi^2. A bonus means the higher the value the lower the chi^2 value,

Author:
Jamie Macaulay
See Also:

  • Field Details

    • useCorrelation

      public boolean useCorrelation
      True to use cross correlation to calculate ICI values.

    • coastPenalty

      public double coastPenalty
      The penalty factor for a single coast.

    • newTrackPenalty

      public double newTrackPenalty
      The penalty factor for starting a new track.

    • longTrackExponent

      public double longTrackExponent
      Exponent for the long track bonus - no point in using a multiplier because then just multiplying all tracks by the same number. Thus the higher this is the more the more weight is given to longer tracks. Make zero to remove bonus

    • lowICIExponent

      public double lowICIExponent
      Exponent for the low ICI track bonus - no point in using a multiplier because then just multiplying all tracks by the same number. Thus the higher this is the more the more weight is given to loweer ICI tracks. Make zero to remove bonus.

    • longTrackBonus

      @Deprecated public double longTrackBonus
      Deprecated.
      The bonus factor for having a longer track.

    • lowTrackICIBonus

      @Deprecated public double lowTrackICIBonus
      Deprecated.
      Bonus factor for a track with lower ICI.

    • maxICIMultipler

      @Deprecated public double maxICIMultipler
      Deprecated.
      The maximum multiple of the median ICI of a track that maximum ICI of the track can be. Deprecated. No longer used.

    • newTrackN

      public int newTrackN
      The maximum number of detections after which a track is no longer considered a new track.

    • JUNK_TRACK_PENALTY

      public static double JUNK_TRACK_PENALTY
      Penalty which is added when a track is considered junk (i.e. with a median IDI value well over the maximum allowed) but not yet tagged for removal from the probability mix. Essentially this is designed to put the track to the back of the queue.

    • chi2Settings

      public Object[] chi2Settings
      Simply stores bespoke settings class for mhtChi2Vars; Only used because ArrayListinvalid input: '<'MHTChi2Var> is not serializable.

    • enable

      public boolean[] enable
      List of enabled params.

    • useElectricNoiseFilter

      public boolean useElectricNoiseFilter
      True to add a test as to whether data is too consistent, i.e. likely to be electrical noise..

    • electricalNoiseParams

      public SimpleElectricalNoiseParams electricalNoiseParams
      Simple electrical noise parameters.

  • Constructor Details

    • StandardMHTChi2Params

      public StandardMHTChi2Params()

    • StandardMHTChi2Params

      public StandardMHTChi2Params(ArrayList<MHTChi2Var<PamDataUnit>> arrayList)

  • Method Details

    • clone

      public StandardMHTChi2Params clone()
      Overrides:
      clone in class MHTChi2Params

    • restoreSettings

      public void restoreSettings()
      Description copied from class: MHTChi2Params
      Called whenever settings have been restored.
      Overrides:
      restoreSettings in class MHTChi2Params

    • restoreSettings

      public void restoreSettings(ArrayList<MHTChi2Var<PamDataUnit>> mhtChi2Vars)
      Restore settings of chi2 vars from the saved settings chi2settings objects.
      Parameters:
      mhtChi2Vars - - the chi2 vars to restore settings for.

    • printMHTVarClass

      public void printMHTVarClass()
      Print the class types for each of MHT variable settings.

    • printSettings

      public void printSettings()
      Print the settings for the params class.

    • getParameterSet

      public PamParameterSet getParameterSet()
      Description copied from interface: ManagedParameters
      Get a set of data that describes all of the parameters in a class
      Specified by:
      getParameterSet in interface ManagedParameters
      Overrides:
      getParameterSet in class MHTChi2Params
      Returns:
      description of the parameters in a class.