Package group3dlocaliser.algorithm.toadmcmc

Class ToadMCMCLocaliser

java.lang.Object

group3dlocaliser.algorithm.LocaliserAlgorithm3D

group3dlocaliser.algorithm.toadbase.TOADBaseAlgorithm

group3dlocaliser.algorithm.toadmcmc.ToadMCMCLocaliser

All Implemented Interfaces:

LocaliserModel<PamDataUnit>

Direct Known Subclasses:

ToadMimplexLocaliser

public class ToadMCMCLocaliser
extends TOADBaseAlgorithm

Nested Class Summary

Nested classes/interfaces inherited from class group3dlocaliser.algorithm.toadbase.TOADBaseAlgorithm

TOADBaseAlgorithm.MultiVariateType

Constructor Summary

Constructors

Constructor	Description
ToadMCMCLocaliser(Group3DLocaliserControl group3dLocaliser)

Method Summary

Modifier and Type	Method	Description
LocaliserPane	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
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.
DetectionGroupedSet	preFilterLoc(DetectionGroupedSet preGroups)	Option to pre-filter the localisation results.
AbstractLocalisation	processTOADs(PamDataUnit groupDataUnit, SnapshotGeometry geometry, TOADInformation toadInformation)	Process the list of delays, which are in seconds

Methods inherited from class group3dlocaliser.algorithm.toadbase.TOADBaseAlgorithm

calcChi2, calcLogLikelihood, canLocalise, checkTOADInformation, countUsableTOADS, countUsableTOADS, estimateCartesianError, estimateEllipticalError, getSourceSettingsPane, getToadBaseParams, prepare, runModel

Methods inherited from class group3dlocaliser.algorithm.LocaliserAlgorithm3D

canArrayShape, getGroupChannelMap, setLocaliserParams

Methods inherited from class java.lang.Object

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

Constructor Details

ToadMCMCLocaliser

public ToadMCMCLocaliser(Group3DLocaliserControl group3dLocaliser)

Method Details

preFilterLoc

public DetectionGroupedSet preFilterLoc(DetectionGroupedSet preGroups)

Description copied from class: LocaliserAlgorithm3D

Option to pre-filter the localisation results. This can be useful when using algorithms that internally handle detection match uncertainty.

Overrides:

preFilterLoc in class LocaliserAlgorithm3D

getName

public String getName()

Description copied from interface: LocaliserModel

Get the name which describes the localiser.

Returns:

the name of the localiser.

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

processTOADs

public AbstractLocalisation processTOADs(PamDataUnit groupDataUnit,
 SnapshotGeometry geometry,
 TOADInformation toadInformation)

Description copied from class: TOADBaseAlgorithm

Process the list of delays, which are in seconds

Specified by:

processTOADs in class TOADBaseAlgorithm

Parameters:

groupDataUnit - group data unit.

toadInformation - all information on delays, errors, channels, etc.

Returns:

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.