Package clickDetector

Class ClickTrainDetector

java.lang.Object
PamguardMVC.PamProcess
clickDetector.ClickTrainDetector
All Implemented Interfaces:
PamSettings, SettingsNameProvider, PamObserver, ProcessAnnotator
public class ClickTrainDetector extends PamProcess implements PamSettings

  • Constructor Details

  • Method Details

    • clearAllTrains

      public void clearAllTrains()

    • getTrackedClickDataBlock

      public PamDataBlock<PamDataUnit> getTrackedClickDataBlock()
      Convenience method for getting the tracked click data block.
      Returns:
      tracked click data block.

    • getRequiredDataHistory

      public long getRequiredDataHistory(PamObservable o, Object arg)
      Specified by:
      getRequiredDataHistory in interface PamObserver
      Overrides:
      getRequiredDataHistory in class PamProcess
      Parameters:
      arg - optional argument from PamObservable
      Returns:
      time in milliseconds required by data held in PamObservable

    • newData

      public void newData(PamObservable o, PamDataUnit arg)
      Overrides:
      newData in class PamProcess

    • closeTrainTime

      protected double closeTrainTime()

    • processClick

      protected ClickTrainDetection processClick(ClickDetection newClick)

    • matchClickIntoGroup

      protected ClickTrainDetection matchClickIntoGroup(ClickDetection newClick)

    • localiseClickTrain

      protected void localiseClickTrain(ClickTrainDetection clickTrain)

    • pamStart

      public void pamStart()
      Description copied from class: PamProcess
      Called for each process to tell it to start (may not be necessary for processes which are listening for data anyway).
      Specified by:
      pamStart in class PamProcess

    • pamStop

      public void pamStop()
      Description copied from class: PamProcess
      Stops the process.
      Specified by:
      pamStop in class PamProcess

    • setSampleRate

      public void setSampleRate(float sampleRate, boolean notify)
      Description copied from interface: PamObserver
      New sample rate
      Specified by:
      setSampleRate in interface PamObserver
      Overrides:
      setSampleRate in class PamProcess
      Parameters:
      sampleRate -
      notify - Notify other PamObservers and PamObservables in the chain.

    • 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

    • 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

    • 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

    • getDetectionGroupLocaliser

      public ClickGroupLocaliser getDetectionGroupLocaliser()

    • getClickTrainIdParameters

      public ClickTrainIdParams getClickTrainIdParameters()
      Returns:
      the clickTrainIdParameters

    • setClickTrainIdParameters

      public void setClickTrainIdParameters(ClickTrainIdParams clickTrainIdParameters)
      Parameters:
      clickTrainIdParameters - the clickTrainIdParameters to set