clickDetector.ClickClassifiers

Interface ClickIdentifier

All Known Implementing Classes:

BasicClickIdentifier, NullClassifier, SweepClassifier

public interface ClickIdentifier

Author:

Doug Gillespie

Interface for click identification from the click detector

Method Summary

Methods

Modifier and Type	Method and Description
int	codeToListIndex(int code)
boolean	fillXMLParamaeters(org.w3c.dom.Document doc, org.w3c.dom.Element classEl)
double	getClickLength(ClickDetection click) Returns the click length for the sweep classifier, 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) return the peak/mean frequency search range for the sweep classifier, or a null.
java.lang.String[]	getSpeciesList()
java.lang.String	getSpeciesName(int code)
PamSymbol	getSymbol(ClickDetection click)
PamSymbol[]	getSymbols()
ZeroCrossingStats[]	getZeroCrossingStats(ClickDetection click) return the zeroCrossingStats object in the case of the sweep classifier, or a null.
ClickIdInformation	identify(ClickDetection click)

Method Detail

identify

ClickIdInformation identify(ClickDetection click)

getMenuItem

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

getSymbol

PamSymbol getSymbol(ClickDetection click)

getSpeciesList

java.lang.String[] getSpeciesList()

getSymbols

PamSymbol[] getSymbols()

codeToListIndex

int codeToListIndex(int code)

getDialogPanel

ClassifyDialogPanel getDialogPanel(java.awt.Frame windowFrame)

getSpeciesName

java.lang.String getSpeciesName(int code)

fillXMLParamaeters

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

getParamsInfo

java.lang.String getParamsInfo(ClickDetection click)

getCodeList

int[] getCodeList()

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

Returns:

int array with the codes

getCommonParams

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.

Parameters:

code - the click type to check

Returns:

the ClickTypeCommonParams object related to the species code

getZeroCrossingStats

ZeroCrossingStats[] getZeroCrossingStats(ClickDetection click)

return the zeroCrossingStats object in the case of the sweep classifier, or a null. 2014/07/25 MO

Parameters:

click - the clickDetection to examine

Returns:

getPeakSearchRange

double[] getPeakSearchRange(ClickDetection click)

return the peak/mean frequency search range for the sweep classifier, or a null. 2014/08/03 MO

Parameters:

click - the clickDetection to examine

Returns:

getClickLength

double getClickLength(ClickDetection click)

Returns the click length for the sweep classifier, using the times returned by the SweepClassifierWorker method getLengthData. In the case of a different classifier, or if there is an error in the sweep classifier, a 0 is returned. 2014/10/13 MO

Parameters:

click - the current click detection

Returns:

the click duration, in seconds