Package clickDetector.ClickClassifiers.basicSweep

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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
double[]	amplitudeRange
double[]	bearingLims
int	channelChoices
static final int	CHANNELS_REQUIRE_ALL
static final int	CHANNELS_REQUIRE_ONE
static final int	CHANNELS_USE_MEANS
static final int	CLICK_CENTER
static final int	CLICK_START
double[][]	controlEnergyBand
double	corrFactor
static final String[]	defaultSpecies
boolean	enableBearingLims
boolean	enableEnergyBands
boolean	enableFFTFilter
boolean	enableLength
boolean	enableMean
boolean	enableMinXCrossCorr
boolean	enablePeak
boolean	enablePeakXCorr
boolean	enableSweep
boolean	enableWidth
boolean	enableZeroCrossings
double[]	energyThresholds
boolean	excludeBearingLims
FFTFilterParams	fftFilterParams
double	lengthdB
int	lengthSmoothing
double	maxLength
double[]	meanRange
double	minCorr
double	minLength
static final int	nControlBands
int[]	nCrossings
double[]	peakRange
double[]	peakSearchRange
int	peakSmoothing
double[]	peakWidthRange
double	peakWidthThreshold
int	restrictedBins
int	restrictedBinstype	The type of length restriction.
boolean	restrictLength
static final long	serialVersionUID
PamSymbol	symbol
boolean	testAmplitude
double[]	testEnergyBand
double[]	zcSweep

Fields inherited from class clickDetector.ClickClassifiers.ClickTypeCommonParams

alarm, alarmEnabled, maxTime, prevTime

Constructor Summary

Constructors

Constructor	Description
SweepClassifierSet()

Method Summary

Modifier and Type	Method	Description
void	beakedWhaleDefaults()
boolean	canProcess(double sampleRate, boolean verbose)	check that the settings can be processed at the current sample rate.
void	checkBearingAllocation()
void	checkCompatibility()	Copied from the clone method...
void	checkEnergyParamsAllocation()
void	checkPeakFreqAllocation()
void	checkXCCorrAllocation()
void	checkZCAllocation()	Check whether zero crossing parameters are set up properly
protected SweepClassifierSet	clone()
static String	getChannelOptionsName(int iOpt)
PamParameterSet	getParameterSet()	Get a set of data that describes all of the parameters in a class
double[]	getPeakSearchRange()
protected boolean	needLength()
void	porpoiseDefaults()
void	setDiscard(Boolean discard)
void	setName(String name)
void	setSpeciesCode(int speciesCode)
boolean	setSpeciesDefaults(String species)

Methods inherited from class clickDetector.ClickClassifiers.ClickTypeCommonParams

getAlarm, getAlarmEnabled, getDiscard, getEnable, getEnableObject, getMaxTime, getName, getPrevTime, getSpeciesCode, setAlarm, setAlarmEnabled, setEnable, setMaxTime, setPrevTime

Methods inherited from class java.lang.Object

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

Field Details

defaultSpecies

public static final transient String[] defaultSpecies

serialVersionUID

public static final long serialVersionUID

See Also:

• Constant Field Values

symbol

public PamSymbol symbol

CHANNELS_REQUIRE_ALL

public static final int CHANNELS_REQUIRE_ALL

See Also:

• Constant Field Values

CHANNELS_REQUIRE_ONE

public static final int CHANNELS_REQUIRE_ONE

See Also:

• Constant Field Values

CHANNELS_USE_MEANS

public static final int CHANNELS_USE_MEANS

See Also:

• Constant Field Values

CLICK_CENTER

public static final int CLICK_CENTER

See Also:

• Constant Field Values

CLICK_START

public static final int CLICK_START

See Also:

• Constant Field Values

channelChoices

public int channelChoices

restrictLength

public boolean restrictLength

restrictedBins

public int restrictedBins

restrictedBinstype

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

public boolean enableLength

lengthSmoothing

public int lengthSmoothing

lengthdB

public double lengthdB

minLength

public double minLength

maxLength

public double maxLength

nControlBands

public static final transient int nControlBands

See Also:

• Constant Field Values

enableEnergyBands

public boolean enableEnergyBands

testEnergyBand

public double[] testEnergyBand

controlEnergyBand

public double[][] controlEnergyBand

energyThresholds

public double[] energyThresholds

testAmplitude

public boolean testAmplitude

amplitudeRange

public double[] amplitudeRange

enableFFTFilter

public boolean enableFFTFilter

fftFilterParams

public FFTFilterParams fftFilterParams

enablePeak

public boolean enablePeak

enableWidth

public boolean enableWidth

enableMean

public boolean enableMean

peakSearchRange

public double[] peakSearchRange

peakRange

public double[] peakRange

peakWidthRange

public double[] peakWidthRange

meanRange

public double[] meanRange

peakSmoothing

public int peakSmoothing

peakWidthThreshold

public double peakWidthThreshold

enableZeroCrossings

public boolean enableZeroCrossings

nCrossings

public int[] nCrossings

enableSweep

public boolean enableSweep

zcSweep

public double[] zcSweep

enableMinXCrossCorr

public boolean enableMinXCrossCorr

enablePeakXCorr

public boolean enablePeakXCorr

minCorr

public double minCorr

corrFactor

public double corrFactor

enableBearingLims

public boolean enableBearingLims

excludeBearingLims

public boolean excludeBearingLims

bearingLims

public double[] bearingLims

Constructor Details

SweepClassifierSet

public SweepClassifierSet()

Method Details

getChannelOptionsName

public static String getChannelOptionsName(int iOpt)

clone

protected SweepClassifierSet clone()

Overrides:

clone in class ClickTypeCommonParams

checkCompatibility

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

public void checkEnergyParamsAllocation()

checkPeakFreqAllocation

public void checkPeakFreqAllocation()

checkZCAllocation

public void checkZCAllocation()

Check whether zero crossing parameters are set up properly

checkXCCorrAllocation

public void checkXCCorrAllocation()

checkBearingAllocation

public void checkBearingAllocation()

canProcess

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

protected boolean needLength()

Returns:

true if one or more tests require length data.

setSpeciesDefaults

public boolean setSpeciesDefaults(String species)

beakedWhaleDefaults

public void beakedWhaleDefaults()

porpoiseDefaults

public void porpoiseDefaults()

getPeakSearchRange

public double[] getPeakSearchRange()

Returns:

the peakSearchRange

setName

public void setName(String name)

Overrides:

setName in class ClickTypeCommonParams

Parameters:

name - the name to set

setSpeciesCode

public void setSpeciesCode(int speciesCode)

Overrides:

setSpeciesCode in class ClickTypeCommonParams

Parameters:

speciesCode - the speciesCode to set

setDiscard

public void setDiscard(Boolean discard)

Overrides:

setDiscard in class ClickTypeCommonParams

Parameters:

discard - the discard to set

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

Overrides:

getParameterSet in class ClickTypeCommonParams

Returns:

description of the parameters in a class.