staticLocaliser.algorithms

Class Mimplex

java.lang.Object

staticLocaliser.algorithms.AbstractSLAlgorithm

staticLocaliser.algorithms.Mimplex

All Implemented Interfaces:

SLAlgorithmModel

public class Mimplex
extends AbstractSLAlgorithm

'Mimplex' is a hybrid algorithm designed to speed up localisations. Mimplex uses Hyperbolic and/or Simplex (...possibly add more in future...) to find the time delay possibility with the lowest chi^2 value and then localises that possibility using MCMC. Since simplex sometime has a tendancy to iterate to infinity the first possibility can also localised as this often corresponds to the correct direct path detections. In this case the best MCMC result, either possibility 0 or the best possibility from Simplex will be recorded.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor and Description
Mimplex(StaticLocalise staticLocalise)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Algorithm name
PamSymbol	getPlotSymbol(int iResult) Simple 2D symbol for the map and results table
java.lang.String	getToolTipText() Tip for different algorithms - usually brief description.
boolean	hasParameters() Specifies if the algorithm has a settings dialog
boolean	isIndependent() Called whenever a localiser will deal itself with multiple time delays.
boolean	parametersDialog() Opens a settings dialog if the 'settings' button on the algorithm panel is selected.
java.util.ArrayList<SLResult>	runModel() Because this algorithm is independent there a few extra things that need to be taken care of in the runModel() function which are normally called in the Staticlocalise class.
boolean	stop() Called to stop algorithm calculations
void	update(int updateType) Called whenever updates are called in other panels is changed.

Methods inherited from class staticLocaliser.algorithms.AbstractSLAlgorithm

calcDetectionMatchTDs, calcNonNullDelays, getCurrentDetection, getDelayArray, getDisplayPanel, getHighlightAppearance, getHydrophonePos, getNormalAppearance, getPlotSymbol3D, getSymbolColour, getSymbolHightlightColour, getTimeDelayErrors, getTimeDelays, isSelected, runModel, setCurrentDetection, setHighlightAppearance, setNormalAppearance, setSelected

Methods inherited from class java.lang.Object

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

Constructor Detail

Mimplex

public Mimplex(StaticLocalise staticLocalise)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: SLAlgorithmModel

Algorithm name

Returns:

the name of this algorithm

getToolTipText

public java.lang.String getToolTipText()

Description copied from interface: SLAlgorithmModel

Tip for different algorithms - usually brief description.

Returns:

hasParameters

public boolean hasParameters()

Description copied from interface: SLAlgorithmModel

Specifies if the algorithm has a settings dialog

Returns:

true if the localiser has a settings dialog.

parametersDialog

public boolean parametersDialog()

Description copied from interface: SLAlgorithmModel

Opens a settings dialog if the 'settings' button on the algorithm panel is selected.

Returns:

runModel

public java.util.ArrayList<SLResult> runModel()

Because this algorithm is independent there a few extra things that need to be taken care of in the runModel() function which are normally called in the Staticlocalise class. If the the algorithm takes a long time then it will periodically have to check if the stop button has been pressed. It needs to deal with time delay possibilities itself and must also plot symbols on the map itself.

Returns:

an arraylist of StaticLocalisationResults. The reason for using an arraylist is multiple solutions maybe obtained.

getPlotSymbol

public PamSymbol getPlotSymbol(int iResult)

Description copied from interface: SLAlgorithmModel

Simple 2D symbol for the map and results table

Returns:

update

public void update(int updateType)

Description copied from interface: SLAlgorithmModel

Called whenever updates are called in other panels is changed. Only ever used for algorithms which have additional 3D symbols, such as the hyperbole in the hyperbolic localiser.

stop

public boolean stop()

Description copied from interface: SLAlgorithmModel

Called to stop algorithm calculations

Specified by:

stop in interface SLAlgorithmModel

Overrides:

stop in class AbstractSLAlgorithm

Returns:

true of algorithm stopped succussfully.

isIndependent

public boolean isIndependent()

Description copied from interface: SLAlgorithmModel

Called whenever a localiser will deal itself with multiple time delays. e.g.often when localising all time delay possibilities are processed independently by the StaticLocalise class. An independent localiser is passed the information on time delay possibilities but is only ever called once from the locaiser (rathar than being called for each possibility). It is therefore allowed to deal with time delay possibilities however it sees fit - this often requires more involved programming for the algorithm. Essentially allows localisers not based on time delay possibilities to function without been called too many times.

Specified by:

isIndependent in interface SLAlgorithmModel

Overrides:

isIndependent in class AbstractSLAlgorithm

Returns:

true if independent, false if not (default).