Package Localiser

Interface LocaliserModel<T extends PamDataUnit>

Type Parameters:

T - - the type of PamDataUnit

U - - the settings class for the localiser.

All Known Subinterfaces:

TargetMotionModel<T>

All Known Implementing Classes:

AbstractTargetMotionModel, AbstractTimeDelayLocaliser, ClickGroupLocaliser, CrossedBearingGroupLocaliser, DetectionGroupLocaliser2, GeneralGroupLocaliser, HyperbolicLocaliser, LeastSquaresNew, LocaliserAlgorithm3D, MFPGridSearch, Simplex2DNew, Simplex3DNew, TOADBaseAlgorithm, TOADGridSearch, ToadMCMCLocaliser, ToadMimplexLocaliser, ToadSimplexLocaliser

public interface LocaliserModel<T extends PamDataUnit>

All localisers in PAMGuard should satisfy this interface.

Author:

Jamie Macaulay

Method Summary

Modifier and Type	Method	Description
LocaliserPane<?>	getAlgorithmSettingsPane()	Get the settings pane for the localiser.
LocContents	getLocContents()	The type of localisation information the localiser can accept.
String	getName()	Get the name which describes the localiser.
String	getToolTipText()
boolean	hasParams()	True if the model has parameters to set.
void	notifyModelProgress(double progress)	This should be called whenever the localiser has finished processing and, if the localisation process is long, then updates progress.
AbstractLocalisation	runModel(T pamDataUnit, DetectionGroupOptions detectionGroupOptions, boolean addLoc)	Run the localisation model.

Method Details

getName

String getName()

Get the name which describes the localiser.

Returns:

the name of the localiser.

getToolTipText

String getToolTipText()

getLocContents

LocContents getLocContents()

The type of localisation information the localiser can accept. e.g. bearings, time delays etc. The types are defined in the AbstractLocalisation class.

Returns:

integer bitmap of the type of localisation information the localiser can use.

getAlgorithmSettingsPane

LocaliserPane<?> getAlgorithmSettingsPane()

Get the settings pane for the localiser. Allows users to change localiser settings.

Returns:

the settings pane for the localiser.

hasParams

boolean hasParams()

True if the model has parameters to set. If has the localiser has a settings pane it will have parameters. This generally puts an extra button onto a display panel.

runModel

AbstractLocalisation runModel(T pamDataUnit,
 DetectionGroupOptions detectionGroupOptions,
 boolean addLoc)

Run the localisation model. Once completed the results are added to the AbstractLoclaisation class of the input PamDataUnit. Note that algorithms may run on a separate thread. Once processing has finished the notifyModelFinished function is called with a progress of 1;.

Parameters:

pamDataUnit - the pamDataUnit. This can be a super unit if multiple detections are required.

addLoc - automatically add the localisation result to the data unit, replacing it's current localisation info.

notifyModelProgress

void notifyModelProgress(double progress)

This should be called whenever the localiser has finished processing and, if the localisation process is long, then updates progress.