Package group3dlocaliser.algorithm.crossedbearing

Class CrossedBearingGroupLocaliser

java.lang.Object

group3dlocaliser.algorithm.LocaliserAlgorithm3D

group3dlocaliser.algorithm.crossedbearing.CrossedBearingGroupLocaliser

All Implemented Interfaces:

LocaliserModel<PamDataUnit>

public class CrossedBearingGroupLocaliser
extends LocaliserAlgorithm3D

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CrossedBearingGroupLocaliser.CrossedBearingPane	Settings pane for the crossed bearing loclaiser.

Constructor Summary

Constructors

Constructor	Description
CrossedBearingGroupLocaliser(Group3DLocaliserControl group3dLocaliserControl)

Method Summary

Modifier and Type	Method	Description
boolean	canLocalise(PamDataBlock pamDataBlock)
LocaliserPane<Serializable>	getAlgorithmSettingsPane()	Get an algorithm specific settings pane.
LocContents	getLocContents()	The type of localisation information the localiser can accept.
String	getName()	Get the name which describes the localiser.
SQLLoggingAddon	getSQLLoggingAddon(int arrayType)	Get SQL Logging Addon data to append to the basic database table
TMAnnotationOptions	getTmAnnotationOptions()
TMAnnotationType	getTmAnnotationType()
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.
boolean	prepare(PamDataBlock sourceBlock)
AbstractLocalisation	runModel(PamDataUnit groupDataUnit, DetectionGroupOptions detectionGroupOptions, boolean addLoc)	Run the localisation model.
void	setTmAnnotationOptions(TMAnnotationOptions tmAnnotationOptions)

Methods inherited from class group3dlocaliser.algorithm.LocaliserAlgorithm3D

canArrayShape, getGroupChannelMap, getSourceSettingsPane, preFilterLoc, setLocaliserParams

Methods inherited from class java.lang.Object

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

Constructor Details

CrossedBearingGroupLocaliser

public CrossedBearingGroupLocaliser(Group3DLocaliserControl group3dLocaliserControl)

Method Details

getName

public String getName()

Description copied from interface: LocaliserModel

Get the name which describes the localiser.

Returns:

the name of the localiser.

prepare

public boolean prepare(PamDataBlock sourceBlock)

Specified by:

prepare in class LocaliserAlgorithm3D

runModel

public AbstractLocalisation runModel(PamDataUnit groupDataUnit,
 DetectionGroupOptions detectionGroupOptions,
 boolean addLoc)

Description copied from interface: LocaliserModel

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:

groupDataUnit - 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.

getSQLLoggingAddon

public SQLLoggingAddon getSQLLoggingAddon(int arrayType)

Description copied from class: LocaliserAlgorithm3D

Get SQL Logging Addon data to append to the basic database table

Specified by:

getSQLLoggingAddon in class LocaliserAlgorithm3D

Parameters:

arrayType - type of array - which may affect how logging is organised.

Returns:

SQL Logging information.

getTmAnnotationOptions

public TMAnnotationOptions getTmAnnotationOptions()

Returns:

the tmAnnotationOptions

setTmAnnotationOptions

public void setTmAnnotationOptions(TMAnnotationOptions tmAnnotationOptions)

Parameters:

tmAnnotationOptions - the tmAnnotationOptions to set

getTmAnnotationType

public TMAnnotationType getTmAnnotationType()

Returns:

the tmAnnotationType

getToolTipText

public String getToolTipText()

getLocContents

public LocContents getLocContents()

Description copied from interface: LocaliserModel

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

public LocaliserPane<Serializable> getAlgorithmSettingsPane()

Description copied from class: LocaliserAlgorithm3D

Get an algorithm specific settings pane. This holds settings which are specific to the localisation algorithm.

Specified by:

getAlgorithmSettingsPane in interface LocaliserModel<PamDataUnit>

Overrides:

getAlgorithmSettingsPane in class LocaliserAlgorithm3D

Returns:

the settings pane for the localiser.

hasParams

public boolean hasParams()

Description copied from interface: LocaliserModel

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.

notifyModelProgress

public void notifyModelProgress(double progress)

Description copied from interface: LocaliserModel

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

canLocalise

public boolean canLocalise(PamDataBlock pamDataBlock)

Specified by:

canLocalise in class LocaliserAlgorithm3D

Returns:

true if this algorithm can process this type of data.