staticLocaliser.panels

Class ClickLocaliserControl

java.lang.Object

staticLocaliser.panels.AbstractLocaliserControl

staticLocaliser.panels.ClickLocaliserControl

All Implemented Interfaces:

PamSettings, LocaliserControlModel, SLPanel

public class ClickLocaliserControl
extends AbstractLocaliserControl
implements LocaliserControlModel, PamSettings

Constructor Summary

Constructors

Constructor and Description
ClickLocaliserControl(StaticLocaliserControl staticLocaliserControl)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLocalise(PamDetection pamDetection) Checks to see if this pamDetection can be localised.
int[]	getChannelMap() Had to implement this as offline datablocks had problems with channel maps.
PamDetection	getCurrentDetection()
java.util.ArrayList<PamDetection>	getCurrentDetections()
java.lang.Integer	getDetectionType() return a flag to calculate what subset of detections to classify.
java.lang.String	getLocaliserPanelName()
PamPanel	getPanel()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
StaticLocalisationMainPanel	getStaticMainPanel() Get the static main panel that this component belongs to.
java.lang.String	getUnitName()
java.lang.String	getUnitType()
boolean	isPaused() The display is paused if the pause check box is selected in the tdGrpah.
void	loadData(long timeStart, long timeEnd) Refresh all the data in the control panel.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setCurrentDetection(PamDetection pamDetection) Set the current detection.
void	update(int flag) Update the dialog.

Methods inherited from class staticLocaliser.panels.AbstractLocaliserControl

enableComponents, getLayerPanel, notifyDetectionUpdate, setlayerPanelEnabled, updatePanelsDetectionUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

ClickLocaliserControl

public ClickLocaliserControl(StaticLocaliserControl staticLocaliserControl)

Method Detail

getLocaliserPanelName

public java.lang.String getLocaliserPanelName()

Overrides:

getLocaliserPanelName in class AbstractLocaliserControl

getPanel

public PamPanel getPanel()

Specified by:

getPanel in interface SLPanel

Returns:

the panel to show in the main panel.

setCurrentDetection

public void setCurrentDetection(PamDetection pamDetection)

Description copied from interface: SLPanel

Set the current detection. Some dialog components will change depending on the type of PamDetection

Specified by:

setCurrentDetection in interface SLPanel

update

public void update(int flag)

Description copied from interface: SLPanel

Update the dialog. This can be called any time from any other part of the static localisation module at any time. Use to interact other dialog components. Integer variable is a flag which indicates what kind of update to perform. Specific types of update are found in 'Static Localise'. These include runnig an algorithm, changing the selected pamDetection and changing the selected time delay.

Specified by:

update in interface SLPanel

canLocalise

public boolean canLocalise(PamDetection pamDetection)

Description copied from interface: LocaliserControlModel

Checks to see if this pamDetection can be localised. This will depend on the settings in the control panel. For example, if a control panel selects that only clicks classified as a certain species can be used then this function should return true if the pamDetection belongs to this species. This function is mainly used to test pamDetection out with loaded data i.e. the input pamDetection does NOT necassarily have to be in the current set of loaded data.

Specified by:

canLocalise in interface LocaliserControlModel

Returns:

loadData

public void loadData(long timeStart,
            long timeEnd)

Description copied from interface: LocaliserControlModel

Refresh all the data in the control panel. This is called when offline data is loaded, a datablock is changed, channels changed, or data is added to a datablock. When offline, data is loaded between timeStart and timeEnd in PAMGUARD millis. If timeStart and timeEnd are -1 then the data in the current data block is loaded.

Specified by:

loadData in interface LocaliserControlModel

getCurrentDetection

public PamDetection getCurrentDetection()

Specified by:

getCurrentDetection in interface LocaliserControlModel

Returns:

the current selected detection in the control panel.

getCurrentDetections

public java.util.ArrayList<PamDetection> getCurrentDetections()

Specified by:

getCurrentDetections in interface LocaliserControlModel

Returns:

a list of all the detection shown in the control panel.

getDetectionType

public java.lang.Integer getDetectionType()

Description copied from interface: LocaliserControlModel

return a flag to calculate what subset of detections to classify. For example, clicks have flags which allow only classified or event type clicks to be considered for time calculations

Specified by:

getDetectionType in interface LocaliserControlModel

Returns:

getStaticMainPanel

public StaticLocalisationMainPanel getStaticMainPanel()

Description copied from interface: SLPanel

Get the static main panel that this component belongs to.

Specified by:

getStaticMainPanel in interface SLPanel

Returns:

getChannelMap

public int[] getChannelMap()

Description copied from interface: LocaliserControlModel

Had to implement this as offline datablocks had problems with channel maps. Get the channel map.

Specified by:

getChannelMap in interface LocaliserControlModel

isPaused

public boolean isPaused()

The display is paused if the pause check box is selected in the tdGrpah. Must update the main localiser display in order to disable/enable localiser button.

Specified by:

isPaused in interface LocaliserControlModel

Overrides:

isPaused in class AbstractLocaliserControl

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

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

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