Package rawDeepLearningClassifier.dlClassification.orcaSpot

Class OrcaSpotClassifier

java.lang.Object
rawDeepLearningClassifier.dlClassification.orcaSpot.OrcaSpotClassifier
All Implemented Interfaces:
PamSettings, SettingsNameProvider, DLClassiferModel
@Deprecated public class OrcaSpotClassifier extends Object implements DLClassiferModel, PamSettings
Deprecated.
Calls python.exe to run a python script and then returns a result. OrcaSpot has been replaced by AnimalSpot - a more generic, faster and easier to setup and use version of the classifier.
Author:
Jamie Macaulay

  • Field Details

    • MAX_QUEUE_SIZE

      public static final int MAX_QUEUE_SIZE
      Deprecated.
      The maximum allowed queue size;
      See Also:

  • Constructor Details

    • OrcaSpotClassifier

      public OrcaSpotClassifier(DLControl dlControl)
      Deprecated.

  • Method Details

    • getName

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

    • getModelUI

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

    • getDLModelSettings

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

    • runModel

      public ArrayList<? extends PredictionResult> runModel(ArrayList<? extends PamDataUnit> rawDataUnits)
      Deprecated.
      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
      Returns:
      the deep learning model.

    • prepModel

      public void prepModel()
      Deprecated.
      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

    • getOrcaSpotParams

      public OrcaSpotParams2 getOrcaSpotParams()
      Deprecated.
      Get OrcaSpot params
      Returns:
      the orca spot params.

    • setOrcaSpotParams

      public void setOrcaSpotParams(OrcaSpotParams2 orcaSpotParams2)
      Deprecated.
      Set the OrcaSpot parameters.
      Parameters:
      orcaSpotParams2 - - the new parameters to set.

    • closeModel

      public void closeModel()
      Deprecated.
      Description copied from interface: DLClassiferModel
      Called whenever PAMGuard stops.
      Specified by:
      closeModel in interface DLClassiferModel

    • getUnitName

      public String getUnitName()
      Deprecated.
      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()
      Deprecated.
      Specified by:
      getUnitType in interface PamSettings
      Returns:
      A Name specific to the type, e.g. Click detector

    • getSettingsReference

      public Serializable getSettingsReference()
      Deprecated.
      Specified by:
      getSettingsReference in interface PamSettings
      Returns:
      The serialisable object that will be stored

    • getSettingsVersion

      public long getSettingsVersion()
      Deprecated.
      Specified by:
      getSettingsVersion in interface PamSettings
      Returns:
      An integer version number for the settings

    • restoreSettings

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

    • getRawDataQueue

      public int getRawDataQueue()
      Deprecated.
      Get the current number of raw data units in the queue.
      Returns:
      the number of dtaa units in the queue.

    • getLastPrediction

      public OrcaSpotModelResult getLastPrediction()
      Deprecated.
      Get the last prediction. Convenience function as this could be acquired from the data block.
      Returns:
      the last prediction.

    • getNumClasses

      public int getNumClasses()
      Deprecated.
      Description copied from interface: DLClassiferModel
      Get the number of output classes.
      Specified by:
      getNumClasses in interface DLClassiferModel
      Returns:
      the number of output classes.

    • getClassNames

      public DLClassName[] getClassNames()
      Deprecated.
      Description copied from interface: DLClassiferModel
      Get the number of output classes.
      Specified by:
      getClassNames in interface DLClassiferModel
      Returns:
      the number of output classes.

    • getDLControl

      public DLControl getDLControl()
      Deprecated.
      Description copied from interface: DLClassiferModel
      Reference to the dlControl
      Specified by:
      getDLControl in interface DLClassiferModel
      Returns:
      reference to the DL control.

    • getModelStatus

      public DLStatus getModelStatus()
      Deprecated.
      Description copied from interface: DLClassiferModel
      Check whether a model has been selected and can be loaded successfully.
      Specified by:
      getModelStatus in interface DLClassiferModel

    • isModelType

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

    • setModel

      public DLStatus setModel(URI model)
      Deprecated.
      Description copied from interface: DLClassiferModel
      Set and load the model.
      Specified by:
      setModel in interface DLClassiferModel
      Returns:
      the status of the model e.g. if there has been an error loading

    • getAllowedDataTypes

      public ArrayList<Class> getAllowedDataTypes()
      Deprecated.
      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
      Returns:
      a list of the allowed data types.