Package clickDetector.echoDetection

Class SimpleEchoDetectionSystem

java.lang.Object

clickDetector.echoDetection.EchoDetectionSystem

clickDetector.echoDetection.SimpleEchoDetectionSystem

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class SimpleEchoDetectionSystem
extends EchoDetectionSystem
implements PamSettings

Very simple echo detection system which uses a single test of time between the previous click and this click to determine if it's an echo or not.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor	Description
SimpleEchoDetectionSystem(ClickControl clickcontrol)

Method Summary

Modifier and Type	Method	Description
EchoDetector	createEchoDetector(ClickDetector.ChannelGroupDetector channelGroupDetector, int channelBitmap)	Get an echo detection object for a set of channels.
EchoDialogPanel	getEchoDialogPanel()	Get a dialog panel to be included in a larger or more general dialog.
Serializable	getSettingsReference()
long	getSettingsVersion()
String	getUnitName()
String	getUnitType()
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class clickDetector.echoDetection.EchoDetectionSystem

getClickcontrol

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleEchoDetectionSystem

public SimpleEchoDetectionSystem(ClickControl clickcontrol)

Method Details

createEchoDetector

public EchoDetector createEchoDetector(ClickDetector.ChannelGroupDetector channelGroupDetector,
 int channelBitmap)

Description copied from class: EchoDetectionSystem

Get an echo detection object for a set of channels.

Specified by:

createEchoDetector in class EchoDetectionSystem

Parameters:

channelBitmap - channels to be included in this particular echo detector.

Returns:

an echo detector for a group of channels.

getEchoDialogPanel

public EchoDialogPanel getEchoDialogPanel()

Description copied from class: EchoDetectionSystem

Get a dialog panel to be included in a larger or more general dialog.

Specified by:

getEchoDialogPanel in class EchoDetectionSystem

Returns:

a dialog panel.

getSettingsReference

public 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 String getUnitName()

Specified by:

getUnitName in interface SettingsNameProvider

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Click 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