Package clickDetector.ClickClassifiers

Class ClickTypeCommonParams

java.lang.Object
clickDetector.ClickClassifiers.ClickTypeCommonParams
All Implemented Interfaces:
Serializable, Cloneable, ManagedParameters
Direct Known Subclasses:
ClickTypeParams, SweepClassifierSet
public abstract class ClickTypeCommonParams extends Object implements Cloneable, Serializable, ManagedParameters
Superclass for click parameters, including the ClickTypeParms and SweepClassifierSet classes. Created to allow simple access to the alarm- specific parameters
Author:
Michael Oswald
See Also:

  • Field Details

    • serialVersionUID

      public static final long serialVersionUID
      See Also:

    • name

      protected String name
      The name of the classifier

    • speciesCode

      protected int speciesCode
      The species code of the classifier

    • discard

      protected Boolean discard
      True to discard classified clicks insteac of calssifiying them.

    • alarm

      protected ClickAlarm alarm
      Alarm to be used for detection

    • alarmEnabled

      protected Boolean alarmEnabled
      boolean indicating whether or not the alarm has been enabled

    • prevTime

      protected long prevTime
      the time (in milliseconds) of the previous detection

    • maxTime

      protected long maxTime
      the maximum amount of time allowed (in milliseconds) between clicks to still be counted as a detection (for alarm purposes)

  • Constructor Details

    • ClickTypeCommonParams

      public ClickTypeCommonParams()

  • Method Details

    • getAlarm

      public ClickAlarm getAlarm()
      Returns the ClickAlarm associated with this click type.
      Returns:
      the ClickAlarm

    • setAlarm

      public void setAlarm(ClickAlarm alarm)
      Sets the alarm used for this click type. This is used in the setupProcess() method of ClickDetector to reset a species code's alarm to the default alarm, in case the original alarm has been deleted.
      Parameters:
      clickAlarm - the clickAlarm to apply

    • getAlarmEnabled

      public Boolean getAlarmEnabled()
      Returns true/false on whether an alarm has been enabled for the click
      Returns:
      Boolean indicating status

    • setAlarmEnabled

      public void setAlarmEnabled(Boolean alarmEnabled)

    • getPrevTime

      public long getPrevTime()

    • setPrevTime

      public void setPrevTime(long prevTime)

    • getMaxTime

      public long getMaxTime()

    • setMaxTime

      public void setMaxTime(long maxTime)

    • clone

      protected ClickTypeCommonParams clone()
      Overrides:
      clone in class Object

    • getDiscard

      public Boolean getDiscard()

    • getName

      public String getName()
      Returns:
      the name

    • setName

      public void setName(String name)
      Parameters:
      name - the name to set

    • getSpeciesCode

      public int getSpeciesCode()
      Returns:
      the speciesCode

    • setSpeciesCode

      public void setSpeciesCode(int speciesCode)
      Parameters:
      speciesCode - the speciesCode to set

    • getEnable

      public boolean getEnable()
      Returns:
      the enable

    • getEnableObject

      public Boolean getEnableObject()
      Don't use this function. Use getEnable which will return a primitive and default to true. This is used for some startup checks to deal with a bug.
      Returns:

    • setEnable

      public void setEnable(boolean enable)
      Set enabled.
      Parameters:
      enable -

    • setDiscard

      public void setDiscard(Boolean discard)
      Parameters:
      discard - the discard to set

    • 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
      Returns:
      description of the parameters in a class.