Package clickTrainDetector.classification

Interface CTClassifier

All Known Implementing Classes:
BearingClassifier, Chi2ThresholdClassifier, CTTemplateClassifier, IDIClassifier, StandardClassifier
public interface CTClassifier
A classifier which is used to classify groups of detections

In keep with PAMGuard convention the classification has a species flag. In general positive values indicate a species whilst negative values indicate noise or some unwanted classification. A 0 value means a click train is totally unclassified and should be deleted. Generally an ID of 0 is only used by the pre-classifier when running through the detection process for the first time.

Author:
Jamie Macaulay

  • Field Details

    • PRECLASSIFIERFLAG

      static final int PRECLASSIFIERFLAG
      Flag which indicates that the classification has passed the pre-classifier stage.
      See Also:

    • NOSPECIES

      static final int NOSPECIES
      Flag which indicates the click train is completely unclassified and should be deleted.
      See Also:

  • Method Details

    • classifyClickTrain

      CTClassification classifyClickTrain(CTDataUnit clickTrain)
      Classify a click train detection.
      Returns:
      the classified data block.

    • getName

      String getName()
      Get the name of the classifier.
      Returns:
      the name of the classifier

    • getSpeciesID

      int getSpeciesID()
      Get the unique species ID for the classifier.
      Returns:
      the name of the classifier

    • getCTClassifierGraphics

      CTClassifierGraphics getCTClassifierGraphics()

    • setParams

      void setParams(CTClassifierParams ctClassifierParams)
      Set the classifier parameters.
      Parameters:
      ctClassifierParams - - the ct classifier paratmers

    • getParams

      CTClassifierParams getParams()
      Get the CT classifier params.
      Returns:
      the CT classifier params.