Class SweepClassifierSet

java.lang.Object
clickDetector.ClickClassifiers.ClickTypeCommonParams
clickDetector.ClickClassifiers.basicSweep.SweepClassifierSet
All Implemented Interfaces:
Serializable, Cloneable, ManagedParameters

public class SweepClassifierSet extends ClickTypeCommonParams implements Serializable, Cloneable, ManagedParameters
Parameters for the sweep click classifier. Also handles some basic data cehcking
Author:
Doug Gillespie
See Also:
  • Field Details Link icon

    • defaultSpecies Link icon

      public static final transient String[] defaultSpecies
    • serialVersionUID Link icon

      public static final long serialVersionUID
      See Also:
    • symbol Link icon

      public PamSymbol symbol
    • CHANNELS_REQUIRE_ALL Link icon

      public static final int CHANNELS_REQUIRE_ALL
      See Also:
    • CHANNELS_REQUIRE_ONE Link icon

      public static final int CHANNELS_REQUIRE_ONE
      See Also:
    • CHANNELS_USE_MEANS Link icon

      public static final int CHANNELS_USE_MEANS
      See Also:
    • CLICK_CENTER Link icon

      public static final int CLICK_CENTER
      See Also:
    • CLICK_START Link icon

      public static final int CLICK_START
      See Also:
    • channelChoices Link icon

      public int channelChoices
    • restrictLength Link icon

      public boolean restrictLength
    • restrictedBins Link icon

      public int restrictedBins
    • restrictedBinstype Link icon

      public int restrictedBinstype
      The type of length restriction. O is around the click sensor and 1 is a simple trim from the start of the click.
    • enableLength Link icon

      public boolean enableLength
    • lengthSmoothing Link icon

      public int lengthSmoothing
    • lengthdB Link icon

      public double lengthdB
    • minLength Link icon

      public double minLength
    • maxLength Link icon

      public double maxLength
    • nControlBands Link icon

      public static final transient int nControlBands
      See Also:
    • enableEnergyBands Link icon

      public boolean enableEnergyBands
    • testEnergyBand Link icon

      public double[] testEnergyBand
    • controlEnergyBand Link icon

      public double[][] controlEnergyBand
    • energyThresholds Link icon

      public double[] energyThresholds
    • testAmplitude Link icon

      public boolean testAmplitude
    • amplitudeRange Link icon

      public double[] amplitudeRange
    • enableFFTFilter Link icon

      public boolean enableFFTFilter
    • fftFilterParams Link icon

      public FFTFilterParams fftFilterParams
    • enablePeak Link icon

      public boolean enablePeak
    • enableWidth Link icon

      public boolean enableWidth
    • enableMean Link icon

      public boolean enableMean
    • peakSearchRange Link icon

      public double[] peakSearchRange
    • peakRange Link icon

      public double[] peakRange
    • peakWidthRange Link icon

      public double[] peakWidthRange
    • meanRange Link icon

      public double[] meanRange
    • peakSmoothing Link icon

      public int peakSmoothing
    • peakWidthThreshold Link icon

      public double peakWidthThreshold
    • enableZeroCrossings Link icon

      public boolean enableZeroCrossings
    • nCrossings Link icon

      public int[] nCrossings
    • enableSweep Link icon

      public boolean enableSweep
    • zcSweep Link icon

      public double[] zcSweep
    • enableMinXCrossCorr Link icon

      public boolean enableMinXCrossCorr
    • enablePeakXCorr Link icon

      public boolean enablePeakXCorr
    • minCorr Link icon

      public double minCorr
    • corrFactor Link icon

      public double corrFactor
    • enableBearingLims Link icon

      public boolean enableBearingLims
    • excludeBearingLims Link icon

      public boolean excludeBearingLims
    • bearingLims Link icon

      public double[] bearingLims
  • Constructor Details Link icon

    • SweepClassifierSet Link icon

      public SweepClassifierSet()
  • Method Details Link icon

    • getChannelOptionsName Link icon

      public static String getChannelOptionsName(int iOpt)
    • clone Link icon

      protected SweepClassifierSet clone()
      Overrides:
      clone in class ClickTypeCommonParams
    • checkCompatibility Link icon

      public void checkCompatibility()
      Copied from the clone method... enableSweep has been separated from enableZeroCrossings, but for backwards compatibility set them to be the same if the version is being reved.
    • checkEnergyParamsAllocation Link icon

      public void checkEnergyParamsAllocation()
    • checkPeakFreqAllocation Link icon

      public void checkPeakFreqAllocation()
    • checkZCAllocation Link icon

      public void checkZCAllocation()
      Check whether zero crossing parameters are set up properly
    • checkXCCorrAllocation Link icon

      public void checkXCCorrAllocation()
    • checkBearingAllocation Link icon

      public void checkBearingAllocation()
    • canProcess Link icon

      public boolean canProcess(double sampleRate, boolean verbose)
      check that the settings can be processed at the current sample rate.
      Parameters:
      sampleRate - sample rate in Hz
      verbose - true if you want visible warning messages.
      Returns:
      true if OK, false otherwise.
    • needLength Link icon

      protected boolean needLength()
      Returns:
      true if one or more tests require length data.
    • setSpeciesDefaults Link icon

      public boolean setSpeciesDefaults(String species)
    • beakedWhaleDefaults Link icon

      public void beakedWhaleDefaults()
    • porpoiseDefaults Link icon

      public void porpoiseDefaults()
    • getPeakSearchRange Link icon

      public double[] getPeakSearchRange()
      Returns:
      the peakSearchRange
    • setName Link icon

      public void setName(String name)
      Overrides:
      setName in class ClickTypeCommonParams
      Parameters:
      name - the name to set
    • setSpeciesCode Link icon

      public void setSpeciesCode(int speciesCode)
      Overrides:
      setSpeciesCode in class ClickTypeCommonParams
      Parameters:
      speciesCode - the speciesCode to set
    • setDiscard Link icon

      public void setDiscard(Boolean discard)
      Overrides:
      setDiscard in class ClickTypeCommonParams
      Parameters:
      discard - the discard to set
    • getParameterSet Link icon

      public PamParameterSet getParameterSet()
      Description copied from interface: ManagedParameters
      Get a set of data that describes all of the parameters in a class
      Specified by:
      getParameterSet in interface ManagedParameters
      Overrides:
      getParameterSet in class ClickTypeCommonParams
      Returns:
      description of the parameters in a class.