public class BasicClickIdentifier extends java.lang.Object implements ClickIdentifier, PamSettings
Identifies individual clicks to type (e.g. porpoise, beaked whale, etc) using methods developed by Marjolaine Caillat, SMRU, in 2005.
Classification is based on the following:
Constructor and Description |
---|
BasicClickIdentifier(ClickControl clickControl) |
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)
Returns a JMenuItem which will launch a dialog for defining different
click types.
|
java.lang.String |
getParamsInfo(ClickDetection click) |
double[] |
getPeakSearchRange(ClickDetection click)
method used to get peak frequency search range from sweep identifier.
|
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)
method used to get zero crossing data from sweep identifier.
|
boolean |
haveClickTypes()
Quick check to see if any click types have been defined
|
ClickIdInformation |
identify(ClickDetection click)
Identifies a click.
|
boolean |
restoreSettings(PamControlledUnitSettings pamControlledUnitSettings) |
public BasicClickIdentifier(ClickControl clickControl)
clickDetector
- public javax.swing.JMenuItem getMenuItem(java.awt.Frame parentFrame)
getMenuItem
in interface ClickIdentifier
public boolean haveClickTypes()
public ClickIdInformation identify(ClickDetection click)
identify
in interface ClickIdentifier
click
- A click from the detectorpublic java.io.Serializable getSettingsReference()
getSettingsReference
in interface PamSettings
public long getSettingsVersion()
getSettingsVersion
in interface PamSettings
public java.lang.String getUnitName()
getUnitName
in interface PamSettings
public java.lang.String getUnitType()
getUnitType
in interface PamSettings
public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
restoreSettings
in interface PamSettings
public PamSymbol getSymbol(ClickDetection click)
getSymbol
in interface ClickIdentifier
public java.lang.String[] getSpeciesList()
getSpeciesList
in interface ClickIdentifier
public PamSymbol[] getSymbols()
getSymbols
in interface ClickIdentifier
public int codeToListIndex(int code)
codeToListIndex
in interface ClickIdentifier
public java.lang.String getSpeciesName(int code)
getSpeciesName
in interface ClickIdentifier
public ClassifyDialogPanel getDialogPanel(java.awt.Frame windowFrame)
getDialogPanel
in interface ClickIdentifier
public boolean fillXMLParamaeters(org.w3c.dom.Document doc, org.w3c.dom.Element classEl)
fillXMLParamaeters
in interface ClickIdentifier
public java.lang.String getParamsInfo(ClickDetection click)
getParamsInfo
in interface ClickIdentifier
public int[] getCodeList()
getCodeList
in interface ClickIdentifier
public ClickTypeCommonParams getCommonParams(int code)
getCommonParams
in interface ClickIdentifier
code
- the click type to checkpublic ZeroCrossingStats[] getZeroCrossingStats(ClickDetection click)
getZeroCrossingStats
in interface ClickIdentifier
click
- the clickDetection to examinepublic double[] getPeakSearchRange(ClickDetection click)
getPeakSearchRange
in interface ClickIdentifier
click
- the clickDetection to examinepublic double getClickLength(ClickDetection click)
getClickLength
in interface ClickIdentifier
click
- the current click detection