Package rawDeepLearningClassifier.dlClassification.orcaSpot

Class OrcaSpotModelResult

java.lang.Object
rawDeepLearningClassifier.dlClassification.orcaSpot.OrcaSpotModelResult
All Implemented Interfaces:
PredictionResult
public class OrcaSpotModelResult extends Object implements PredictionResult
Stores results from an OrcaSpot classification
Author:
Jamie Macaulay

  • Field Details

    • timeSeconds

      public double timeSeconds
      The time in seconds.

    • detectionConfidence

      public float[] detectionConfidence
      The detection confidence

    • calltypeConfidence

      public Float calltypeConfidence
      The call type confidence

    • binaryClassification

      public boolean binaryClassification
      Do we call this a yes/no classification

    • predictedClass

      public String predictedClass
      Description of the predicted class

  • Constructor Details

    • OrcaSpotModelResult

      public OrcaSpotModelResult(Double detConf, Double time)
      Constructor for an OrcaSpot result if only a detection has occurred.
      Parameters:
      detConf - - the confidence.
      time - - the time in seconds.

    • OrcaSpotModelResult

      public OrcaSpotModelResult()

  • Method Details

    • getPrediction

      public float[] getPrediction()
      Get the detection confidence.
      Specified by:
      getPrediction in interface PredictionResult
      Returns:
      the detection confidence

    • isBinaryClassification

      public boolean isBinaryClassification()
      Description copied from interface: PredictionResult
      Check whether binary classification has passed.
      Specified by:
      isBinaryClassification in interface PredictionResult
      Returns:
      true if binary classification has passed

    • setBinaryClassification

      public void setBinaryClassification(boolean binaryClassification)
      Set whether the binary classification has passed.
      Parameters:
      binaryClassification - - true if the binary classification has passed.

    • getAnalysisTime

      public double getAnalysisTime()
      Description copied from interface: PredictionResult
      Get the analysis time.
      Specified by:
      getAnalysisTime in interface PredictionResult
      Returns:
      the analysis time.

    • setAnlaysisTime

      public void setAnlaysisTime(double timeSeconds)
      Set the analysis time in seconds.
      Parameters:
      timeSeconds - - the analysis time in seconds.

    • getResultString

      public String getResultString()
      Description copied from interface: PredictionResult
      String representation of the result
      Specified by:
      getResultString in interface PredictionResult
      Returns:
      a string of the result.

    • getClassNames

      public short[] getClassNames()
      Description copied from interface: PredictionResult
      Get the class name IDs associated with this result. Can be null. @see DLClassNameManager to get strings of class names.
      Specified by:
      getClassNames in interface PredictionResult
      Returns:
      a list of the class name ID for the result. Can be null or an array the same length as getPrediciton();

    • getTimeMillis

      public long getTimeMillis()
      Description copied from interface: PredictionResult
      Get the time stamp.
      Specified by:
      getTimeMillis in interface PredictionResult
      Returns:
      the millis datenumber.

    • getFreqLimits

      public double[] getFreqLimits()
      Description copied from interface: PredictionResult
      Get frequency limits of the prediction result
      Specified by:
      getFreqLimits in interface PredictionResult
      Returns:
      the frequency limits of the prediction result

    • getStartSample

      public long getStartSample()
      Description copied from interface: PredictionResult
      Get the start sample - this is the sample number of the first sample in the result. * Note: required for object detection results where the start sample may not be same as the input data
      Specified by:
      getStartSample in interface PredictionResult
      Returns:
      the start sample

    • getSampleDuration

      public int getSampleDuration()
      Description copied from interface: PredictionResult
      Get duration in sample - this is the number of samples in the result. Note: required for object detection results where the duration is not the same as the input data
      Specified by:
      getSampleDuration in interface PredictionResult
      Returns:
      the duration of the result in samples.