Package rawDeepLearningClassifier.dlClassification

Interface DLClassiferModel

All Known Implementing Classes:
ArchiveModelClassifier, DelphinIDClassifier, DummyClassifier, GenericDLClassifier, KetosClassifier, KetosClassifier2, KooguClassifier, OrcaSpotClassifier, PamZipModelClassifier, SoundSpotClassifier, StandardClassifierModel
public interface DLClassiferModel
The classifier model. Each classifier must satisfy this interface.
Author:
Jamie Macaulay

  • Method Details

    • runModel

      ArrayList<? extends PredictionResult> runModel(ArrayList<? extends PamDataUnit> rawDataUnit)
      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.

      Returns:
      the deep learning model.

    • prepModel

      void prepModel()
      Prepare the model. This is called on PAMGuard start up.
      Parameters:
      file -

    • setModel

      DLStatus setModel(URI model)
      Called whenever PAMGuard stops.
      Returns:

    • isModelType

      boolean isModelType(URI model)
      Check whether a URI is compatible with a classification framework
      Parameters:
      model - - the URI to the model
      Returns:
      true if the model is compatible.

    • closeModel

      void closeModel()
      Called whenever PAMGuard stops.

    • getName

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

    • getModelUI

      DLCLassiferModelUI getModelUI()
      Get any UI components for the model. Can be null.
      Returns:
      UI components for the model.

    • getDLModelSettings

      Serializable getDLModelSettings()
      A settings object that can be saved.
      Returns:
      the settings object.

    • getNumClasses

      int getNumClasses()
      Get the number of output classes.
      Returns:
      the number of output classes.

    • getClassNames

      DLClassName[] getClassNames()
      Get the number of output classes.
      Returns:
      the number of output classes.

    • getDLControl

      DLControl getDLControl()
      Reference to the dlControl
      Returns:
      reference to the DL control.

    • getModelStatus

      DLStatus getModelStatus()
      Check whether a model has been selected and can be loaded successfully.

    • getDLTransformParams

      static ArrayList<org.jamdev.jdl4pam.transforms.DLTransfromParams> getDLTransformParams(ArrayList<org.jamdev.jdl4pam.transforms.DLTransform> dlTransfroms)
      Get the parameters which can be serialized from transforms.
      Parameters:
      dlTransfroms - - the DL transforms.