likelihoodDetectionModule

Class TargetConfiguration

java.lang.Object

likelihoodDetectionModule.TargetConfiguration

All Implemented Interfaces:

java.io.Serializable

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

The Class TargetConfiguration represents a single configuration for the likelihood detector, which can run multiple configurations simultaneously. A configuration is represented by a number of parameters that control the scope and accuracy of the area and the characteristics to be detected. Also there are one or more SignalBand definitions and zero or more GuardBand definitions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TargetConfiguration.State The State enumeration represents the current activity state of the TargetConfiguration, that is, whether is is currently requested to be active by the user (or, alternately inactive), or whether there is an error in one of the parameters of the configuration.

Constructor Summary

Constructors

Constructor and Description
TargetConfiguration(AcquisitionSettings acquisitionSettings, int channelMap) Instantiates a new target configuration.

Method Summary

Methods

Modifier and Type	Method and Description
void	calibrate(AcquisitionSettings acquisitionSettings, int channelMap) Calibrate the TargetConfiguration against the supplied audio source parameters (the AcquisitionSettings) and the channel map.
AcquisitionSettings	getAcquisitionSettings() Gets the acquisition settings.
NormalizerProcess.NormalizerAlgorithm	getAlgorithm() Gets the algorithm.
static java.lang.String[]	getAlgorithmNames() Get the names of the available likelihood normalization algorithms.
int	getChannelMap()
LikelihoodFFTParameters	getFFTParameters() Gets the fFT parameters.
double	getFrequencyResolution() Gets the frequency resolution.
double[]	getFrequencyResolutionLimits() Gets the frequency resolution limits.
java.util.ArrayList<GuardBand>	getGuardBands() Gets the guard bands.
java.lang.String	getIdentifier() Gets the identifier.
double	getReferenceGain() Gets the reference gain.
double	getSecondsBetweenDetections() Gets the seconds between detections.
double[]	getSecondsBetweenDetectionsLimits() Gets the seconds between detections limits.
java.util.ArrayList<SignalBand>	getSignalBands() Gets the signal bands.
TargetConfiguration.State	getState() Gets the state of the TargetConfiguration.
double	getTimeResolution() Gets the time resolution.
double[]	getTimeResolutionLimits() Gets the time resolution limits.
void	setAlgorithm(NormalizerProcess.NormalizerAlgorithm algorithm) Sets the algorithm.
void	setFrequencyResolution(double frequencyResolution) Sets the frequency resolution.
void	setGuardBands(java.util.ArrayList<GuardBand> bands) Sets the guard bands.
void	setIdentifier(java.lang.String identifier) Sets the identifier.
void	setSecondsBetweenDetections(double s) Sets the seconds between detections.
void	setSignalBands(java.util.ArrayList<SignalBand> signalBands) Sets the signal bands.
void	setState(TargetConfiguration.State s) Sets the state of the configuration.
void	setTimeResolution(double timeResolution) Sets the time resolution.

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetConfiguration

public TargetConfiguration(AcquisitionSettings acquisitionSettings,
                   int channelMap)

Instantiates a new target configuration. The audio source settings and the channel map are required in order to automatically configure and limit various parameters for the detector.

Parameters:

acquisitionSettings - the acquisition settings

channelMap - the channel map

Method Detail

getAlgorithmNames

public static java.lang.String[] getAlgorithmNames()

Get the names of the available likelihood normalization algorithms.

Returns:

the algorithm names

setState

public void setState(TargetConfiguration.State s)

Sets the state of the configuration.

Parameters:

s - the new state

getState

public TargetConfiguration.State getState()

Gets the state of the TargetConfiguration. This will check all of the parameters and bands for their errors states as well.

Returns:

the state

See Also:

TargetConfiguration.State

setSecondsBetweenDetections

public void setSecondsBetweenDetections(double s)

Sets the seconds between detections.

Parameters:

s - the new seconds between detections

getSecondsBetweenDetections

public double getSecondsBetweenDetections()

Gets the seconds between detections.

Returns:

the seconds between detections

getFFTParameters

public LikelihoodFFTParameters getFFTParameters()

Gets the fFT parameters.

Returns:

the fFT parameters

getTimeResolutionLimits

public double[] getTimeResolutionLimits()

Gets the time resolution limits.

Returns:

the time resolution limits

getFrequencyResolutionLimits

public double[] getFrequencyResolutionLimits()

Gets the frequency resolution limits.

Returns:

the frequency resolution limits

getSecondsBetweenDetectionsLimits

public double[] getSecondsBetweenDetectionsLimits()

Gets the seconds between detections limits.

Returns:

the seconds between detections limits

getSignalBands

public java.util.ArrayList<SignalBand> getSignalBands()

Gets the signal bands.

Returns:

the signal bands

setSignalBands

public void setSignalBands(java.util.ArrayList<SignalBand> signalBands)

Sets the signal bands.

Parameters:

signalBands - the new signal bands

getGuardBands

public java.util.ArrayList<GuardBand> getGuardBands()

Gets the guard bands.

Returns:

the guard bands

setGuardBands

public void setGuardBands(java.util.ArrayList<GuardBand> bands)

Sets the guard bands.

Parameters:

bands - the new guard bands

getIdentifier

public java.lang.String getIdentifier()

Gets the identifier.

Returns:

the identifier

setIdentifier

public void setIdentifier(java.lang.String identifier)

Sets the identifier.

Parameters:

identifier - the new identifier

getTimeResolution

public double getTimeResolution()

Gets the time resolution.

Returns:

the time resolution

setTimeResolution

public void setTimeResolution(double timeResolution)

Sets the time resolution.

Parameters:

timeResolution - the new time resolution

getFrequencyResolution

public double getFrequencyResolution()

Gets the frequency resolution.

Returns:

the frequency resolution

getReferenceGain

public double getReferenceGain()

Gets the reference gain.

Returns:

the reference gain

setFrequencyResolution

public void setFrequencyResolution(double frequencyResolution)

Sets the frequency resolution.

Parameters:

frequencyResolution - the new frequency resolution

getAlgorithm

public NormalizerProcess.NormalizerAlgorithm getAlgorithm()

Gets the algorithm.

Returns:

the algorithm

setAlgorithm

public void setAlgorithm(NormalizerProcess.NormalizerAlgorithm algorithm)

Sets the algorithm.

Parameters:

algorithm - the new algorithm

getAcquisitionSettings

public AcquisitionSettings getAcquisitionSettings()

Gets the acquisition settings.

Returns:

the acquisition settings

getChannelMap

public int getChannelMap()

calibrate

public void calibrate(AcquisitionSettings acquisitionSettings,
             int channelMap)

Calibrate the TargetConfiguration against the supplied audio source parameters (the AcquisitionSettings) and the channel map. This ensures that the parameter limits and other internal variables are correct for the source data, and it also checks the current settings for validity against the source parameters.

Parameters:

acquisitionSettings - the acquisition settings

channelMap - the channel map