Package clickDetector.ClickClassifiers

Interface ClickIdentifier

All Superinterfaces:
ClickTypeProvider
All Known Implementing Classes:
BasicClickIdentifier, NullClassifier, SweepClassifier
public interface ClickIdentifier extends ClickTypeProvider
Author:
Doug Gillespie

Interface for click identification from the click detector

  • Method Details

    • identify

      ClickIdInformation identify(ClickDetection click)
      Identify a click detection as a click type.
      Parameters:
      click - - the click to identfy.
      Returns:
      the click to

    • getMenuItem

      JMenuItem getMenuItem(Frame parentFrame)

    • getSymbol

      PamSymbol getSymbol(ClickDetection click)

    • getDialogPanel

      ClassifyDialogPanel getDialogPanel(Frame windowFrame)

    • getSpeciesName

      String getSpeciesName(int code)

    • getParamsInfo

      String getParamsInfo(ClickDetection click)

    • getSymbols

      PamSymbol[] getSymbols()
      Get symbols for each click type.
      Returns:
      the symbols for type.

    • getCommonParams

      ClickTypeCommonParams getCommonParams(int code)
      Return the superclass of the click type parameters class - currently used for accessing the alarm functions. Subclasses include ClickTypeParams and SweepClassifierSet.
      Parameters:
      code - the click type to check
      Returns:
      the ClickTypeCommonParams object related to the species code

    • getZeroCrossingStats

      ZeroCrossingStats[] getZeroCrossingStats(ClickDetection click)
      return the zeroCrossingStats object in the case of the sweep classifier, or a null. 2014/07/25 MO
      Parameters:
      click - the clickDetection to examine
      Returns:

    • getPeakSearchRange

      double[] getPeakSearchRange(ClickDetection click)
      return the peak/mean frequency search range for the sweep classifier, or a null. 2014/08/03 MO
      Parameters:
      click - the clickDetection to examine
      Returns:

    • getClickLength

      double getClickLength(ClickDetection click)
      Returns the click length for the sweep classifier, using the times returned by the SweepClassifierWorker method getLengthData. In the case of a different classifier, or if there is an error in the sweep classifier, a 0 is returned. 2014/10/13 MO
      Parameters:
      click - the current click detection
      Returns:
      the click duration, in seconds

    • getClassifierPane

      ClassifyPaneFX getClassifierPane()
      A pane which holds specific settings for the click classifier type selected.
      Returns:
      the classifier pane