staticLocaliser.algorithms

Class AbstractSLAlgorithm

java.lang.Object

staticLocaliser.algorithms.AbstractSLAlgorithm

All Implemented Interfaces:

SLAlgorithmModel

Direct Known Subclasses:

HyperboleLoc, MarkovChainSL, Mimplex, Simplex3DStatic

public abstract class AbstractSLAlgorithm
extends java.lang.Object
implements SLAlgorithmModel

This is the abstract class for building an algorithm for the static localiser. Note that a lot of default options have been included here, including a symbol for the map, symbol colour, calculation of time delays for a detection, symbol highlighted appearances etc. These can all be overridden depending on the type of algorithm.

' The time delay calculations simply use the default abstractDetectionMatch.groupDetectionsTD() function, however new localisation algorithms may not want to use all possible time delays approach. In this case, to keep things neat, you should change the subclass of 'AbstractDetectionMatch' for the detection in question- time delays calculations belong in this class- the algorithm should simply accept time delays (or other info) and attempt to localise.

Author:

Jamie Macualay.

Constructor Summary

Constructors

Constructor and Description
AbstractSLAlgorithm(StaticLocalise staticLocalise)

Method Summary

Methods

Modifier and Type	Method and Description
void	calcDetectionMatchTDs(PamDetection pamDetection, java.util.ArrayList<PamDataBlock> dataBlocks, java.lang.Integer detectionType) Calculate the detection match for a PamDetection.
static int	calcNonNullDelays(java.util.ArrayList<TDArrayList<java.lang.Double>> timeDelays) Calculates the number of non null delays within
PamDetection	getCurrentDetection()
static java.util.ArrayList<java.util.ArrayList<java.lang.Double>>	getDelayArray(java.util.ArrayList<TDArrayList<java.lang.Double>> timeDelays) Converts a ArrayList> array to ArrayList> array containing time delay values used by generic PAMGUARD localisation algorithms.
SLPanel	getDisplayPanel() A panel which shows results, chi distributions etc.
javax.media.j3d.Appearance	getHighlightAppearance() If the symbol is selected it changes appearance to this.
java.util.ArrayList<java.util.ArrayList<javax.vecmath.Point3f>>	getHydrophonePos()
javax.media.j3d.Appearance	getNormalAppearance() The normal appearance of the 3D localisation symbol.
javax.media.j3d.TransformGroup	getPlotSymbol3D(SLResult staticLocalisationResults) Default symbol for a localisation is a 3D ellipse with dimensions equal to the calculated errors in 3D.
float[]	getSymbolColour()
float[]	getSymbolHightlightColour()
java.util.ArrayList<java.util.ArrayList<TDArrayList<java.lang.Double>>>	getTimeDelayErrors()
java.util.ArrayList<java.util.ArrayList<TDArrayList<java.lang.Double>>>	getTimeDelays()
boolean	isIndependent() Called whenever a localiser will deal itself with multiple time delays.
boolean	isSelected() Check whether the algorithm is selected
java.util.ArrayList<SLResult>	runModel(java.lang.Integer tdSel) Need to have this for the Mimplex localiser.
void	setCurrentDetection(PamDetection pamDetection)
void	setHighlightAppearance(LocShape3D locShape) Set the highlighted appearance of a locShape.Note usually this will just be using getHighlightAppearance() functionality, however more complicated shapes may want to modify this function.
void	setNormalAppearance(LocShape3D locShape) Set the normal appearance of the locShape.
void	setSelected(boolean selected) Called whenever an algorithm is selected or deselected.
boolean	stop() Called to stop algorithm calculations

Methods inherited from class java.lang.Object

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

Methods inherited from interface staticLocaliser.algorithms.SLAlgorithmModel

getName, getPlotSymbol, getToolTipText, hasParameters, parametersDialog, runModel, update

Constructor Detail

AbstractSLAlgorithm

public AbstractSLAlgorithm(StaticLocalise staticLocalise)

Method Detail

getSymbolColour

public float[] getSymbolColour()

getSymbolHightlightColour

public float[] getSymbolHightlightColour()

calcDetectionMatchTDs

public void calcDetectionMatchTDs(PamDetection pamDetection,
                         java.util.ArrayList<PamDataBlock> dataBlocks,
                         java.lang.Integer detectionType)

Calculate the detection match for a PamDetection. Includes an arraylist of datablocks to be used if an unsynchrnoised array. Otherwise the Arraylist contains only the pamDetections parent datablock. Override this function to use a more complicated finction.

Parameters:

pamDetection -

dataBlocks -

detectionType -

getTimeDelays

public java.util.ArrayList<java.util.ArrayList<TDArrayList<java.lang.Double>>> getTimeDelays()

getHydrophonePos

public java.util.ArrayList<java.util.ArrayList<javax.vecmath.Point3f>> getHydrophonePos()

getTimeDelayErrors

public java.util.ArrayList<java.util.ArrayList<TDArrayList<java.lang.Double>>> getTimeDelayErrors()

getPlotSymbol3D

public javax.media.j3d.TransformGroup getPlotSymbol3D(SLResult staticLocalisationResults)

Default symbol for a localisation is a 3D ellipse with dimensions equal to the calculated errors in 3D.

Specified by:

getPlotSymbol3D in interface SLAlgorithmModel

Returns:

getNormalAppearance

public javax.media.j3d.Appearance getNormalAppearance()

Description copied from interface: SLAlgorithmModel

The normal appearance of the 3D localisation symbol.

Specified by:

getNormalAppearance in interface SLAlgorithmModel

Returns:

getHighlightAppearance

public javax.media.j3d.Appearance getHighlightAppearance()

Description copied from interface: SLAlgorithmModel

If the symbol is selected it changes appearance to this.

Specified by:

getHighlightAppearance in interface SLAlgorithmModel

Returns:

setNormalAppearance

public void setNormalAppearance(LocShape3D locShape)

Description copied from interface: SLAlgorithmModel

Set the normal appearance of the locShape. Note usually this will just be using getNormalAppearance() functionality, however more complicated shapes may want to modify this function.

Specified by:

setNormalAppearance in interface SLAlgorithmModel

setHighlightAppearance

public void setHighlightAppearance(LocShape3D locShape)

Description copied from interface: SLAlgorithmModel

Set the highlighted appearance of a locShape.Note usually this will just be using getHighlightAppearance() functionality, however more complicated shapes may want to modify this function.

Specified by:

setHighlightAppearance in interface SLAlgorithmModel

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

Returns:

isSelected

public boolean isSelected()

Description copied from interface: SLAlgorithmModel

Check whether the algorithm is selected

Specified by:

isSelected in interface SLAlgorithmModel

Returns:

true if algorithm has been selected.

setSelected

public void setSelected(boolean selected)

Description copied from interface: SLAlgorithmModel

Called whenever an algorithm is selected or deselected.

Specified by:

setSelected in interface SLAlgorithmModel

setCurrentDetection

public void setCurrentDetection(PamDetection pamDetection)

getCurrentDetection

public PamDetection getCurrentDetection()

calcNonNullDelays

public static int calcNonNullDelays(java.util.ArrayList<TDArrayList<java.lang.Double>> timeDelays)

Calculates the number of non null delays within

Parameters:

tinmeDelays -

Returns:

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

Returns:

true if independent, false if not (default).

stop

public boolean stop()

Description copied from interface: SLAlgorithmModel

Called to stop algorithm calculations

Specified by:

stop in interface SLAlgorithmModel

Returns:

true of algorithm stopped succussfully.

runModel

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

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

Parameters:

tdSel - - selected time dealy possibility

Returns:

getDelayArray

public static java.util.ArrayList<java.util.ArrayList<java.lang.Double>> getDelayArray(java.util.ArrayList<TDArrayList<java.lang.Double>> timeDelays)

Converts a ArrayList> array to ArrayList> array containing time delay values used by generic PAMGUARD localisation algorithms.

Parameters:

timeDelays - time delay array.

Returns:

time Delay array in correct format for PAMGUARD localisers.