Package rawDeepLearningClassifier.dlClassification.delphinID

Class DelphinIDClassifier

java.lang.Object
rawDeepLearningClassifier.dlClassification.StandardClassifierModel
rawDeepLearningClassifier.dlClassification.delphinID.DelphinIDClassifier
All Implemented Interfaces:
PamSettings, SettingsNameProvider, DLClassiferModel
public class DelphinIDClassifier extends StandardClassifierModel
A classifier based on the delphinID method which uses whistle contours to predict dolphin species.
Author:
Jamie Macaulay

  • Constructor Details

    • DelphinIDClassifier

      public DelphinIDClassifier(DLControl dlControl)

  • Method Details

    • isModelType

      public boolean isModelType(URI model)
      Description copied from interface: DLClassiferModel
      Check whether a URI is compatible with a classification framework
      Parameters:
      model - - the URI to the model
      Returns:
      true if the model is compatible.

    • prepModel

      public void prepModel()
      Description copied from interface: DLClassiferModel
      Prepare the model. This is called on PAMGuard start up and before processing in viewer mode.
      Specified by:
      prepModel in interface DLClassiferModel
      Overrides:
      prepModel in class StandardClassifierModel

    • getName

      public String getName()
      Description copied from interface: DLClassiferModel
      Get the name of the model.
      Returns:
      the name of the model.

    • getModelUI

      public DLCLassiferModelUI getModelUI()
      Description copied from interface: DLClassiferModel
      Get any UI components for the model. Can be null.
      Returns:
      UI components for the model.

    • getDLModelSettings

      public Serializable getDLModelSettings()
      Description copied from interface: DLClassiferModel
      A settings object that can be saved.
      Returns:
      the settings object.

    • getUnitName

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

    • getUnitType

      public String getUnitType()
      Returns:
      A Name specific to the type, e.g. Click detector

    • getSettingsReference

      public Serializable getSettingsReference()
      Returns:
      The serialisable object that will be stored

    • runModel

      public ArrayList<? extends PredictionResult> runModel(ArrayList<? extends PamDataUnit> groupedRawData)
      Description copied from interface: DLClassiferModel
      Run the deep learning model on a list of grouped raw data units and return a corresponding list of model results.

      Note the reason we use list is that often it is more efficient to get a model to predict a stacked group of inputs rather than one at a time.

      Specified by:
      runModel in interface DLClassiferModel
      Overrides:
      runModel in class StandardClassifierModel
      Returns:
      the deep learning model.

    • isDecision

      public boolean isDecision(StandardPrediction modelResult, StandardModelParams modelParmas)
      Description copied from class: StandardClassifierModel
      Make a decision on whether a result passed a decision
      Overrides:
      isDecision in class StandardClassifierModel
      Parameters:
      modelResult - - the model result.
      modelParmas - - the model parameters.
      Returns:
      true if a threshold has been met.

    • getSettingsVersion

      public long getSettingsVersion()
      Returns:
      An integer version number for the settings

    • restoreSettings

      public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
      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

    • getDLWorker

      public DLModelWorker<StandardPrediction> getDLWorker()
      Description copied from class: StandardClassifierModel
      Get the sound spot worker.
      Specified by:
      getDLWorker in class StandardClassifierModel
      Returns:
      the sound spot worker.

    • getDLParams

      public DelphinIDParams getDLParams()
      Description copied from class: StandardClassifierModel
      Get the sound spot worker.
      Specified by:
      getDLParams in class StandardClassifierModel
      Returns:
      the sound spot worker.

    • setDLParams

      public void setDLParams(DelphinIDParams params)

    • getAllowedDataTypes

      public ArrayList<Class> getAllowedDataTypes()
      Description copied from interface: DLClassiferModel
      Get the allowed data types for the model.The can be null in which case only data units with raw data are allowed.
      Specified by:
      getAllowedDataTypes in interface DLClassiferModel
      Overrides:
      getAllowedDataTypes in class StandardClassifierModel
      Returns:
      a list of the allowed data types.