clickDetector.ClickClassifiers.basicSweep

Class SweepClassifier

java.lang.Object

clickDetector.ClickClassifiers.basicSweep.SweepClassifier

All Implemented Interfaces:

ClickIdentifier, PamSettings

public class SweepClassifier
extends java.lang.Object
implements ClickIdentifier, PamSettings

An improvements on the BasicClickIdentifier based on work by Gillespie and Caillat in 2009. Click length is now measured based on the envelope waveform rather than a measure of total energy Have also added some parameters extracted from zero crossings and will include better diagnostic plots and histograms.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor and Description
SweepClassifier(ClickControl clickControl)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	codeDuplicated(SweepClassifierSet sweepClassifierSet, int ignoreRow)
int	codeToListIndex(int code)
boolean	fillXMLParamaeters(org.w3c.dom.Document doc, org.w3c.dom.Element classEl)
ClickDetector	getClickDetector()
double	getClickLength(ClickDetection click) Returns the click length, using the times returned by the SweepClassifierWorker method getLengthData.
int[]	getCodeList() Returns a list of the currently-defined click types / species codes
ClickTypeCommonParams	getCommonParams(int code) Return the superclass of the click type parameters class - currently used for accessing the alarm functions.
ClassifyDialogPanel	getDialogPanel(java.awt.Frame windowFrame)
javax.swing.JMenuItem	getMenuItem(java.awt.Frame parentFrame)
java.lang.String	getParamsInfo(ClickDetection click)
double[]	getPeakSearchRange(ClickDetection click) Returns the frequency search range defined for peak frequency testing 2014/08/03 MO
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.String[]	getSpeciesList()
java.lang.String	getSpeciesName(int code)
PamSymbol	getSymbol(ClickDetection click)
PamSymbol[]	getSymbols()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
ZeroCrossingStats[]	getZeroCrossingStats(ClickDetection click) Returns the zeroCrossingStats variable, used as an identifier in the Rocca interface.
ClickIdInformation	identify(ClickDetection click)
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class java.lang.Object

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

Constructor Detail

SweepClassifier

public SweepClassifier(ClickControl clickControl)

Method Detail

codeToListIndex

public int codeToListIndex(int code)

Specified by:

codeToListIndex in interface ClickIdentifier

getMenuItem

public javax.swing.JMenuItem getMenuItem(java.awt.Frame parentFrame)

Specified by:

getMenuItem in interface ClickIdentifier

getSpeciesList

public java.lang.String[] getSpeciesList()

Specified by:

getSpeciesList in interface ClickIdentifier

getCodeList

public int[] getCodeList()

Returns a list of the currently-defined click types / species codes

Specified by:

getCodeList in interface ClickIdentifier

Returns:

int array with the codes

getSymbol

public PamSymbol getSymbol(ClickDetection click)

Specified by:

getSymbol in interface ClickIdentifier

getCommonParams

public ClickTypeCommonParams getCommonParams(int code)

Return the superclass of the click type parameters class - currently used for accessing the alarm functions. Subclasses include ClickTypeParams and SweepClassifierSet.

Specified by:

getCommonParams in interface ClickIdentifier

Parameters:

code - the click type to check

Returns:

the ClickTypeCommonParams object related to the species code

getSymbols

public PamSymbol[] getSymbols()

Specified by:

getSymbols in interface ClickIdentifier

getDialogPanel

public ClassifyDialogPanel getDialogPanel(java.awt.Frame windowFrame)

Specified by:

getDialogPanel in interface ClickIdentifier

getSpeciesName

public java.lang.String getSpeciesName(int code)

Specified by:

getSpeciesName in interface ClickIdentifier

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getClickDetector

public ClickDetector getClickDetector()

Returns:

the clickDetector

codeDuplicated

public boolean codeDuplicated(SweepClassifierSet sweepClassifierSet,
                     int ignoreRow)

identify

public ClickIdInformation identify(ClickDetection click)

Specified by:

identify in interface ClickIdentifier

fillXMLParamaeters

public boolean fillXMLParamaeters(org.w3c.dom.Document doc,
                         org.w3c.dom.Element classEl)

Specified by:

fillXMLParamaeters in interface ClickIdentifier

getParamsInfo

public java.lang.String getParamsInfo(ClickDetection click)

Specified by:

getParamsInfo in interface ClickIdentifier

getZeroCrossingStats

public ZeroCrossingStats[] getZeroCrossingStats(ClickDetection click)

Returns the zeroCrossingStats variable, used as an identifier in the Rocca interface. 2014/07/25 MO

Specified by:

getZeroCrossingStats in interface ClickIdentifier

Parameters:

click - the Click Detection

Returns:

the ZeroCrossingStats variable

getPeakSearchRange

public double[] getPeakSearchRange(ClickDetection click)

Returns the frequency search range defined for peak frequency testing 2014/08/03 MO

Specified by:

getPeakSearchRange in interface ClickIdentifier

Parameters:

click - the Click Detection

Returns:

the min/max of the search range

getClickLength

public double getClickLength(ClickDetection click)

Returns the click length, using the times returned by the SweepClassifierWorker method getLengthData. If there is an error, a 0 is returned. Note that this defaults to the first channel. 2014/10/13 MO

Specified by:

getClickLength in interface ClickIdentifier

Parameters:

click - the current click detection

Returns:

the duration of the click, in seconds