Package group3dlocaliser.algorithm.gridsearch

Class TOADGridSearch

java.lang.Object

group3dlocaliser.algorithm.LocaliserAlgorithm3D

group3dlocaliser.algorithm.toadbase.TOADBaseAlgorithm

group3dlocaliser.algorithm.gridsearch.TOADGridSearch

All Implemented Interfaces:

LocaliserModel<PamDataUnit>

public class TOADGridSearch
extends TOADBaseAlgorithm

Nested Class Summary

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

TOADBaseAlgorithm.MultiVariateType

Field Summary

Fields

Modifier and Type	Field	Description
static String	gridSearchName

Constructor Summary

Constructors

Constructor	Description
TOADGridSearch(Group3DLocaliserControl group3dLocaliser)

Method Summary

Modifier and Type	Method	Description
boolean	canArrayShape(int arrayShape)	Ask if the algorithm can process this type of array data.
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.
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

getAlgorithmSettingsPane, getGroupChannelMap, preFilterLoc, setLocaliserParams

Methods inherited from class java.lang.Object

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

Field Details

gridSearchName

public static String gridSearchName

Constructor Details

TOADGridSearch

public TOADGridSearch(Group3DLocaliserControl group3dLocaliser)

Method Details

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.

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.

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.

canArrayShape

public boolean canArrayShape(int arrayShape)

Description copied from class: LocaliserAlgorithm3D

Ask if the algorithm can process this type of array data.

Overrides:

canArrayShape in class LocaliserAlgorithm3D

Parameters:

arrayShape - array shape. One of:
ArrayManager.ARRAY_TYPE_NONE
ArrayManager.ARRAY_TYPE_POINT
ArrayManager.ARRAY_TYPE_LINE
ArrayManager.ARRAY_TYPE_PLANE
ArrayManager.ARRAY_TYPE_VOLUME

Returns:

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: