Package clickDetector.alarm

Class ClickAlarmCounter

java.lang.Object
alarm.AlarmCounter
alarm.AlarmDecibelCounter
clickDetector.alarm.ClickAlarmCounter
All Implemented Interfaces:
PamSettings, SettingsNameProvider
public class ClickAlarmCounter extends AlarmDecibelCounter implements PamSettings

  • Constructor Details

  • Method Details

    • getValue

      public double getValue(int countType, PamDataUnit dataUnit)
      Description copied from class: AlarmCounter
      Get a count value from a source of alarm trigger data

      Two types of counting are available. COUNT_SIMPLE in which case each data unit scores either 0 or 1 and COUNT_SCORES in which case each unit is assigned a value (could still be 0 or 1 !)

      Specified by:
      getValue in class AlarmCounter
      Parameters:
      countType - type of counting
      dataUnit - dataunit to consider
      Returns:
      value to add to trigger count.

    • hasOptions

      public boolean hasOptions()
      Overrides:
      hasOptions in class AlarmCounter
      Returns:
      true if the counter has module specific options.

    • showOptions

      public boolean showOptions(Window parent)
      Description copied from class: AlarmCounter
      Show module specific options
      Overrides:
      showOptions in class AlarmCounter
      Parameters:
      parent - parent frame for dialog
      Returns:
      true if options were changed (false if cancel button pressed on dialog)

    • getSettingsReference

      public Serializable getSettingsReference()
      Specified by:
      getSettingsReference in interface PamSettings
      Returns:
      The serialisable object that will be stored

    • getSettingsVersion

      public long getSettingsVersion()
      Specified by:
      getSettingsVersion in interface PamSettings
      Returns:
      An integer version number for the settings

    • getUnitName

      public String getUnitName()
      Specified by:
      getUnitName in interface SettingsNameProvider
      Returns:
      A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

    • getUnitType

      public String getUnitType()
      Specified by:
      getUnitType in interface PamSettings
      Returns:
      A Name specific to the type, e.g. Click detector

    • restoreSettings

      public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
      Specified by:
      restoreSettings in interface PamSettings
      Parameters:
      pamControlledUnitSettings -
      Returns:
      true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

    • addCount

      public double addCount(double currentValue, double countToAdd, int countType)
      Description copied from class: AlarmCounter
      Add a count to the total. This has been put in this abstract class so that individual modules can override how they add things up, e.g. a noise measurement in dB may need to be converted to energy before adding.
      Overrides:
      addCount in class AlarmDecibelCounter
      Parameters:
      currentValue - current value
      countToAdd - amount to add
      countType - type of counting
      Returns:
      the two added together in whichever way is most appropriate.

    • subtractCount

      public double subtractCount(double currentValue, double countToSubtract, int countType)
      Description copied from class: AlarmCounter
      Subtract a count from the total. This has been put in this abstract class so that individual modules can override how they subtract things, e.g. a noise measurement in dB may need to be converted to energy before subtracting.
      Overrides:
      subtractCount in class AlarmDecibelCounter
      Parameters:
      currentValue - current value
      countToSubtract - amount to subtract off
      countType - type of counting
      Returns:
      the two subtracted from one another in whichever way is most appropriate.

    • resetCounter

      public void resetCounter()
      Specified by:
      resetCounter in class AlarmCounter