likelihoodDetectionModule

Class SignalBand

java.lang.Object

likelihoodDetectionModule.SignalBand

All Implemented Interfaces:

java.io.Serializable

public class SignalBand
extends java.lang.Object
implements java.io.Serializable

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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
double	backgroundSeconds The background seconds.
double	endFrequencyHz The end frequency hz.
double[]	frequencyLimits The frequency's limits.
double	guardBandThresholdDb The guard band threshold, in db.
double[]	guardBandThresholdLimits The guard band threshold's limits.
java.lang.String	identifier The signal band identifier.
double	inBandThresholdDb The in-band threshold, in db.
double[]	inBandThresholdLimits The in-band threshold's limits.
double[]	secondsLimits The seconds between detection's limits.
double	signalSeconds The signal seconds.
double	startFrequencyHz The start frequency hz.

Constructor Summary

Constructors

Constructor and Description
SignalBand(AcquisitionSettings acquisitionSettings, LikelihoodFFTParameters fftParams) Instantiates a new signal band.

Method Summary

Methods

Modifier and Type	Method and Description
void	calibrate(AcquisitionSettings acquisitionSettings, LikelihoodFFTParameters fftParams) Calibrates the SignalBand according to the supplied audio data source (acquisition) and FFT parameters.
double	GuardBandAsRatio() The user defines GuardBandThreshold in dB, however the underlying modules require a linear ratio.
double	InBandAsRatio() The user defines InBandThreshold in dB, however the underlying modules require a linear ratio.
boolean	isError() Checks if is error.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

identifier

public java.lang.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 Detail

SignalBand

public SignalBand(AcquisitionSettings acquisitionSettings,
          LikelihoodFFTParameters fftParams)

Instantiates a new signal band.

Parameters:

acquisitionSettings - the acquisition settings

fftParams - the fft params

Method Detail

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:

TargetConfiguration.calibrate(likelihoodDetectionModule.AcquisitionSettings, int)

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