Package whistleClassifier

Class FragmentClassifierParams

java.lang.Object
whistleClassifier.FragmentClassifierParams
All Implemented Interfaces:
Serializable, Cloneable, ManagedParameters
public class FragmentClassifierParams extends Object implements Serializable, Cloneable, ManagedParameters
Parameters class for fragmented whistle classification.

This class contains the basic parameters which could be applied to any fragment classification method including how the whistles were fragmented, and the section length as well as basic information about the input data from the whistle detector.

Sine the classification can use a number of different statistical classifiers, and those classifiers may also be used to solve other classification problems in PAMGUARD the actual classification parameters are stored in a separate abstract class ClassifierParams which are got directly from specific classifiers.

Author:
Doug Gillespie
See Also:

  • Field Details Link icon

    • serialVersionUID Link icon

      public static final long serialVersionUID
      See Also:

    • classifierType Link icon

      public int classifierType

    • fftLength Link icon

      public int fftLength

    • fftHop Link icon

      public int fftHop

    • fragmentLength Link icon

      public int fragmentLength

    • sectionLength Link icon

      public int sectionLength

    • minimumProbability Link icon

      public double minimumProbability
      Min probability for classification.

      In a linear classifier, probabilities are normalised to one, ideally one output is close to one and the others are small, but often you get several candidate values. This should be able to weed these out and create an unknown class.

      With the quadratic classifier, output for each species is an absolute probability so setting a minimum will easily generate an unknown class.

    • frequencyRange Link icon

      public double[] frequencyRange

    • sampleRate Link icon

      public float sampleRate

    • nBootstrap Link icon

      public int nBootstrap

    • confusionMatrix Link icon

      public Jama.Matrix confusionMatrix

    • stdConfusion Link icon

      public Jama.Matrix stdConfusion

    • classifierParams Link icon

      public ClassifierParams classifierParams

    • fileName Link icon

      public String fileName

    • dumpTextFile Link icon

      public boolean dumpTextFile

    • minimumContourLength Link icon

      public int minimumContourLength

  • Constructor Details Link icon

    • FragmentClassifierParams Link icon

      public FragmentClassifierParams()

  • Method Details Link icon

    • getClassifierType Link icon

      public int getClassifierType()

    • setClassifierType Link icon

      public void setClassifierType(int classifierType)

    • setSpeciesList Link icon

      public void setSpeciesList(String[] speciesList)
      Parameters:
      speciesList - the speciesList to set

    • getSpeciesList Link icon

      public String[] getSpeciesList()
      Returns:
      the speciesList

    • getClassifierClass Link icon

      public Class getClassifierClass()

    • getFftLength Link icon

      public int getFftLength()

    • setFftLength Link icon

      public void setFftLength(int fftLength)

    • getFftHop Link icon

      public int getFftHop()

    • setFftHop Link icon

      public void setFftHop(int fftHop)

    • getFileName Link icon

      public String getFileName()

    • getFragmentLength Link icon

      public int getFragmentLength()

    • setFragmentLength Link icon

      public void setFragmentLength(int fragmentLength)

    • getSectionLength Link icon

      public int getSectionLength()

    • setSectionLength Link icon

      public void setSectionLength(int sectionLength)

    • getMinimumProbability Link icon

      public double getMinimumProbability()
      Returns:
      the minimumProbability

    • setMinimumProbability Link icon

      public void setMinimumProbability(double minimumProbability)
      Parameters:
      minimumProbability - the minimumProbability to set

    • getMinimumContourLength Link icon

      public int getMinimumContourLength()
      Returns:
      the minimumContourLength

    • setMinimumContourLength Link icon

      public void setMinimumContourLength(int minimumContourLength)
      Parameters:
      minimumContourLength - the minimumContourLength to set

    • getFrequencyRange Link icon

      public double[] getFrequencyRange()

    • setFrequencyRange Link icon

      public void setFrequencyRange(double[] frequencyRange)

    • getSampleRate Link icon

      public float getSampleRate()

    • setSampleRate Link icon

      public void setSampleRate(float sampleRate)

    • getNBootstrap Link icon

      public int getNBootstrap()

    • setNBootstrap Link icon

      public void setNBootstrap(int bootstrap)

    • getConfusionMatrix Link icon

      public Jama.Matrix getConfusionMatrix()

    • setConfusionMatrix Link icon

      public void setConfusionMatrix(Jama.Matrix confusionMatrix)

    • getStdConfusion Link icon

      public Jama.Matrix getStdConfusion()

    • setStdConfusion Link icon

      public void setStdConfusion(Jama.Matrix stdConfusion)

    • getClassifierParams Link icon

      public ClassifierParams getClassifierParams()

    • getMinFrequency Link icon

      public double getMinFrequency()

    • getMaxFrequency Link icon

      public double getMaxFrequency()

    • setClassifierParams Link icon

      public void setClassifierParams(ClassifierParams classifierParams)

    • clone Link icon

      protected FragmentClassifierParams clone()
      Overrides:
      clone in class Object

    • getParameterSet Link icon

      public PamParameterSet getParameterSet()
      Need to override the Matrix fields here so that they return the double[][] array
      Specified by:
      getParameterSet in interface ManagedParameters
      Returns:
      description of the parameters in a class.