staticLocaliser.algorithms

Class Simplex3DStatic

java.lang.Object

staticLocaliser.algorithms.AbstractSLAlgorithm

staticLocaliser.algorithms.Simplex3DStatic

All Implemented Interfaces:

SLAlgorithmModel

public class Simplex3DStatic
extends AbstractSLAlgorithm
implements SLAlgorithmModel

Simplex3D for the static localiser. Includes a 'LocalisationInformation' panel which allows the visualisation the chi2 surface around the localisation point in three different dimensions.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor and Description
Simplex3DStatic(StaticLocalise staticLocalise)

Method Summary

Methods

Modifier and Type	Method and Description
SLPanel	getDisplayPanel() A panel which shows results, chi distributions etc.
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	parametersDialog() Opens a settings dialog if the 'settings' button on the algorithm panel is selected.
java.util.ArrayList<SLResult>	runModel() Run model.
java.util.ArrayList<SLResult>	runModel(java.lang.Integer tdSel) Run the localiser for a single time delay possibility defined by tdSel.
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, getHighlightAppearance, getHydrophonePos, getNormalAppearance, getPlotSymbol3D, getSymbolColour, getSymbolHightlightColour, getTimeDelayErrors, getTimeDelays, isIndependent, isSelected, setCurrentDetection, setHighlightAppearance, setNormalAppearance, setSelected, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface staticLocaliser.algorithms.SLAlgorithmModel

getHighlightAppearance, getNormalAppearance, getPlotSymbol3D, isIndependent, isSelected, setHighlightAppearance, setNormalAppearance, setSelected, stop

Constructor Detail

Simplex3DStatic

public Simplex3DStatic(StaticLocalise staticLocalise)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: SLAlgorithmModel

Algorithm name

Specified by:

getName in interface SLAlgorithmModel

Returns:

the name of this algorithm

getToolTipText

public java.lang.String getToolTipText()

Description copied from interface: SLAlgorithmModel

Tip for different algorithms - usually brief description.

Specified by:

getToolTipText in interface SLAlgorithmModel

Returns:

hasParameters

public boolean hasParameters()

Description copied from interface: SLAlgorithmModel

Specifies if the algorithm has a settings dialog

Specified by:

hasParameters in interface SLAlgorithmModel

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.

Specified by:

parametersDialog in interface SLAlgorithmModel

Returns:

runModel

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

Description copied from interface: SLAlgorithmModel

Run model. This should implement AbstractDetectionMatch class. From the StaticLocalise class grab:

pamDetection- the current detection selected in the control panel. tdSel- the current selected time delay on the map, loclaisationVisualisation and maybe the localisationInformation panels. detectionType- this is an integer flag which is datablock specific and is passed to the AbstractDetectionMatch class-usually specifies which corresponding detections to calculate time delays from. For example, 'detectiontype' in clickDetectionMatch refers to events, classified species and a combination of the two. For whistles this may refer to whistle classification etc- tdSel refers to which time delay to select. Abstractdetectionmatch creates an array of possible time delays for a given detection. Using these three bits of info use the detections subclass of AbstractDetectionMatch to calc time delays and loclaise.

Specified by:

runModel in interface SLAlgorithmModel

Returns:

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

runModel

public java.util.ArrayList<SLResult> runModel(java.lang.Integer tdSel)

Run the localiser for a single time delay possibility defined by tdSel.

Overrides:

runModel in class AbstractSLAlgorithm

Parameters:

tdSel-the - time delay possibility

Returns:

localisation results.

getPlotSymbol

public PamSymbol getPlotSymbol(int iResult)

Description copied from interface: SLAlgorithmModel

Simple 2D symbol for the map and results table

Specified by:

getPlotSymbol in interface SLAlgorithmModel

Returns:

getDisplayPanel

public SLPanel getDisplayPanel()

Description copied from interface: SLAlgorithmModel

A panel which shows results, chi distributions etc. Can be null if no panel is required.

Specified by:

getDisplayPanel in interface SLAlgorithmModel

Overrides:

getDisplayPanel in class AbstractSLAlgorithm

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.

Specified by:

update in interface SLAlgorithmModel