Package likelihoodDetectionModule

Class SignalBand

java.lang.Object
likelihoodDetectionModule.SignalBand
All Implemented Interfaces:
Serializable, ManagedParameters
public class SignalBand extends Object implements Serializable, ManagedParameters
Represents the parameters that make up a signal band, used as input to the Likelihood detection algorithm. This class is stored in the TargetConfiguration object.
See Also:

  • Field Details

    • identifier

      public String identifier
      The signal band identifier. The configuration dialog will ensure that this is unique for each TargetDetection object.

    • inBandThresholdDb

      public double inBandThresholdDb
      The in-band threshold, in db.

    • guardBandThresholdDb

      public double guardBandThresholdDb
      The guard band threshold, in db.

    • startFrequencyHz

      public double startFrequencyHz
      The start frequency hz.

    • endFrequencyHz

      public double endFrequencyHz
      The end frequency hz.

    • backgroundSeconds

      public double backgroundSeconds
      The background seconds.

    • signalSeconds

      public double signalSeconds
      The signal seconds.

    • inBandThresholdLimits

      public double[] inBandThresholdLimits
      The in-band threshold's limits.

    • guardBandThresholdLimits

      public double[] guardBandThresholdLimits
      The guard band threshold's limits.

    • frequencyLimits

      public double[] frequencyLimits
      The frequency's limits.

    • secondsLimits

      public double[] secondsLimits
      The seconds between detection's limits.

  • Constructor Details

    • SignalBand

      public SignalBand(AcquisitionSettings acquisitionSettings, LikelihoodFFTParameters fftParams)
      Instantiates a new signal band.
      Parameters:
      acquisitionSettings - the acquisition settings
      fftParams - the fft params

  • Method Details

    • calibrate

      public void calibrate(AcquisitionSettings acquisitionSettings, LikelihoodFFTParameters fftParams)
      Calibrates the SignalBand according to the supplied audio data source (acquisition) and FFT parameters.
      Parameters:
      acquisitionSettings - the acquisition settings
      fftParams - the fft params
      See Also:

    • InBandAsRatio

      public double InBandAsRatio()
      The user defines InBandThreshold in dB, however the underlying modules require a linear ratio. This method converts to a ratio, using the formula 10^(x/10)
      Returns:
      The ratio

    • GuardBandAsRatio

      public double GuardBandAsRatio()
      The user defines GuardBandThreshold in dB, however the underlying modules require a linear ratio. This method converts to a ratio, using the formula 10^(x/10)
      Returns:
      The ratio

    • isError

      public boolean isError()
      Checks if is error.
      Returns:
      true, if is error

    • getParameterSet

      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
      Returns:
      description of the parameters in a class.