staticLocaliser.algorithms

Class HyperboleLoc

java.lang.Object

staticLocaliser.algorithms.AbstractSLAlgorithm

staticLocaliser.algorithms.HyperboleLoc

All Implemented Interfaces:

PamSettings, SLAlgorithmModel

public class HyperboleLoc
extends AbstractSLAlgorithm
implements PamSettings

Allows the user to visualise the hyperboloids of time delays

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor and Description
HyperboleLoc(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.io.Serializable	getSettingsReference()
long	getSettingsVersion()
float[]	getSymbolColour()
java.lang.String	getToolTipText() Tip for different algorithms - usually brief description.
java.lang.String	getUnitName()
java.lang.String	getUnitType()
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.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
java.util.ArrayList<SLResult>	runModel() Run model.
java.util.ArrayList<SLResult>	runModel(java.lang.Integer tdSel) Need to have this for the Mimplex localiser.
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, 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

Constructor Detail

HyperboleLoc

public HyperboleLoc(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)

Description copied from class: AbstractSLAlgorithm

Need to have this for the Mimplex localiser. Not required unless algorithm is used for Mimplex localisation.

Overrides:

runModel in class AbstractSLAlgorithm

Parameters:

tdSel - - selected time dealy possibility

Returns:

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:

getSymbolColour

public float[] getSymbolColour()

Overrides:

getSymbolColour in class AbstractSLAlgorithm

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

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required