staticLocaliser.panels

Interface LocaliserControlModel

All Known Implementing Classes:

AbstractLocaliserControl, ClickEventLocaliserControl, ClickLocaliserControl, WhistleLocaliserControl

public interface LocaliserControlModel

Any control panel for the static localiser must use this basic interface and make sure all these functions are implemented properly. The control essentially allows the user to pick a single pamdetection to pass to the localiser. It also specifies what type of detection the user wishes to localise by passing an int flag to the detectionMatch class for the pamDetection. For example, in the case of a clickDetection, the user can pass flags telling the detection match class only to include classified clicks in it's calculation of time delays.

Author:

Jamie Macaulay

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.
boolean	isPaused() Check whether the localiser control panel is paused.
void	loadData(long timeStart, long timeEnd) Refresh all the data in the control panel.

Method Detail

getCurrentDetection

PamDetection getCurrentDetection()

Returns:

the current selected detection in the control panel.

getCurrentDetections

java.util.ArrayList<PamDetection> getCurrentDetections()

Returns:

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

getDetectionType

java.lang.Integer getDetectionType()

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

Returns:

loadData

void loadData(long timeStart,
            long timeEnd)

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.

canLocalise

boolean canLocalise(PamDetection pamDetection)

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.

Returns:

getChannelMap

int[] getChannelMap()

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

isPaused

boolean isPaused()

Check whether the localiser control panel is paused. If paused the real time thread is stopped. Only used in real time operation.