clickDetector.ClickClassifiers

Class NullClassifier

java.lang.Object

clickDetector.ClickClassifiers.NullClassifier

All Implemented Interfaces:

ClickIdentifier

public class NullClassifier
extends java.lang.Object
implements ClickIdentifier

Constructor Summary

Constructors

Constructor and Description
NullClassifier()

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) method used to get peak frequency search range from sweep identifier.
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

NullClassifier

public NullClassifier()

Method Detail

codeToListIndex

public int codeToListIndex(int code)

Specified by:

codeToListIndex in interface ClickIdentifier

getDialogPanel

public ClassifyDialogPanel getDialogPanel(java.awt.Frame windowFrame)

Specified by:

getDialogPanel in interface ClickIdentifier

getMenuItem

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

Specified by:

getMenuItem in interface ClickIdentifier

getSpeciesName

public java.lang.String getSpeciesName(int code)

Specified by:

getSpeciesName in interface ClickIdentifier

getSpeciesList

public java.lang.String[] getSpeciesList()

Specified by:

getSpeciesList in interface ClickIdentifier

getSymbol

public PamSymbol getSymbol(ClickDetection click)

Specified by:

getSymbol in interface ClickIdentifier

getSymbols

public PamSymbol[] getSymbols()

Specified by:

getSymbols in interface ClickIdentifier

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)

Description copied from interface: ClickIdentifier

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

Specified by:

getZeroCrossingStats in interface ClickIdentifier

Parameters:

click - the clickDetection to examine

Returns:

getPeakSearchRange

public double[] getPeakSearchRange(ClickDetection click)

method used to get peak frequency search range from sweep identifier. Return null for basic identifier 2014/08/03 MO

Specified by:

getPeakSearchRange in interface ClickIdentifier

Parameters:

click - the clickDetection to examine

Returns:

getCodeList

public int[] getCodeList()

Description copied from interface: ClickIdentifier

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

Specified by:

getCodeList in interface ClickIdentifier

Returns:

int array with the codes

getCommonParams

public ClickTypeCommonParams getCommonParams(int code)

Description copied from interface: ClickIdentifier

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

getClickLength

public 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, a 0 is returned 2014/10/13 MO

Specified by:

getClickLength in interface ClickIdentifier

Parameters:

click - the current click detection

Returns:

the click duration, in seconds