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

Field Summary

private ClickControl	clickControl
private ClickDetector	clickDetector
private SweepClassifierPanel	dialogPanel
protected SweepClassifierParameters	sweepClassifierParameters
private SweepClassifierWorker	sweepClassifierWorker

Constructor Summary

SweepClassifier(ClickControl clickControl)

Method Summary

boolean	codeDuplicated(SweepClassifierSet sweepClassifierSet, int ignoreRow)
protected boolean	codeTaken(int code)
int	codeToListIndex(int code)
private SweepClassifierSet	findClicktypeSet(int iSpeciesCode)
ClickDetector	getClickDetector()
ClassifyDialogPanel	getDialogPanel(java.awt.Frame windowFrame)
javax.swing.JMenuItem	getMenuItem(java.awt.Frame parentFrame)
protected int	getNextFreeCode(int currCode)
protected int	getPrevFreeCode(int currCode)
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()
ClickIdInformation	identify(ClickDetection click)
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class java.lang.Object

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

Field Detail

clickDetector

private ClickDetector clickDetector

clickControl

private ClickControl clickControl

dialogPanel

private SweepClassifierPanel dialogPanel

sweepClassifierWorker

private SweepClassifierWorker sweepClassifierWorker

sweepClassifierParameters

protected SweepClassifierParameters sweepClassifierParameters

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

getSymbol

public PamSymbol getSymbol(ClickDetection click)

Specified by:

getSymbol in interface ClickIdentifier

findClicktypeSet

private SweepClassifierSet findClicktypeSet(int iSpeciesCode)

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

getNextFreeCode

protected int getNextFreeCode(int currCode)

getPrevFreeCode

protected int getPrevFreeCode(int currCode)

codeTaken

protected boolean codeTaken(int code)

codeDuplicated

public boolean codeDuplicated(SweepClassifierSet sweepClassifierSet,
                              int ignoreRow)

identify

public ClickIdInformation identify(ClickDetection click)

Specified by:

identify in interface ClickIdentifier