Package clickDetector.ClickClassifiers

Class NullClassifier

java.lang.Object

clickDetector.ClickClassifiers.NullClassifier

All Implemented Interfaces:

ClickIdentifier, ClickTypeProvider

public class NullClassifier
extends Object
implements ClickIdentifier

Constructor Summary

Constructors

Constructor	Description
NullClassifier()

Method Summary

Modifier and Type	Method	Description
int	codeToListIndex(int code)	Returns the index in the list for the click type.
ClassifyPaneFX	getClassifierPane()	A pane which holds specific settings for the click classifier type selected.
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(Frame windowFrame)
JMenuItem	getMenuItem(Frame parentFrame)
String	getParamsInfo(ClickDetection click)
double[]	getPeakSearchRange(ClickDetection click)	method used to get peak frequency search range from sweep identifier.
String[]	getSpeciesList()	Get a list of species names.
String	getSpeciesName(int code)
PamSymbol	getSymbol(ClickDetection click)
PamSymbol[]	getSymbols()	Get symbols for each click type.
SymbolData[]	getSymbolsData()	Get a list of symbols for each species corresponding to getSpeciesList.
ZeroCrossingStats[]	getZeroCrossingStats(ClickDetection click)	return the zeroCrossingStats object in the case of the sweep classifier, or a null.
ClickIdInformation	identify(ClickDetection click)	Identify a click detection as a click type.

Methods inherited from class java.lang.Object

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

Constructor Details

NullClassifier

public NullClassifier()

Method Details

codeToListIndex

public int codeToListIndex(int code)

Description copied from interface: ClickTypeProvider

Returns the index in the list for the click type.

Specified by:

codeToListIndex in interface ClickTypeProvider

Parameters:

code - - the click type code

Returns:

the index.

getDialogPanel

public ClassifyDialogPanel getDialogPanel(Frame windowFrame)

Specified by:

getDialogPanel in interface ClickIdentifier

getMenuItem

public JMenuItem getMenuItem(Frame parentFrame)

Specified by:

getMenuItem in interface ClickIdentifier

getSpeciesName

public String getSpeciesName(int code)

Specified by:

getSpeciesName in interface ClickIdentifier

getSpeciesList

public String[] getSpeciesList()

Description copied from interface: ClickTypeProvider

Get a list of species names.

Specified by:

getSpeciesList in interface ClickTypeProvider

Returns:

list speces names.

getSymbol

public PamSymbol getSymbol(ClickDetection click)

Specified by:

getSymbol in interface ClickIdentifier

getSymbols

public PamSymbol[] getSymbols()

Description copied from interface: ClickIdentifier

Get symbols for each click type.

Specified by:

getSymbols in interface ClickIdentifier

Returns:

the symbols for type.

identify

public ClickIdInformation identify(ClickDetection click)

Description copied from interface: ClickIdentifier

Identify a click detection as a click type.

Specified by:

identify in interface ClickIdentifier

Parameters:

click - - the click to identfy.

Returns:

the click to

getParamsInfo

public 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: ClickTypeProvider

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

Specified by:

getCodeList in interface ClickTypeProvider

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

getClassifierPane

public ClassifyPaneFX getClassifierPane()

Description copied from interface: ClickIdentifier

A pane which holds specific settings for the click classifier type selected.

Specified by:

getClassifierPane in interface ClickIdentifier

Returns:

the classifier pane

getSymbolsData

public SymbolData[] getSymbolsData()

Description copied from interface: ClickTypeProvider

Get a list of symbols for each species corresponding to getSpeciesList.

Specified by:

getSymbolsData in interface ClickTypeProvider

Returns:

list of species symbols.