staticLocaliser.resultsAnalysis

Class BasicResultFilter

java.lang.Object

staticLocaliser.resultsAnalysis.BasicResultFilter

All Implemented Interfaces:

PamSettings, SLResultsAnalysis

public class BasicResultFilter
extends java.lang.Object
implements SLResultsAnalysis, PamSettings

Filter for displaying results on the graph. The filter will get rid of results which are unrealistic, i.e. results above surface, way below seabed, high chi^2 values and more. This can be sub classed and set in the control class.

Author:

Jamie Macaulay

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAnalysisName() Get the name
boolean	getParams() Called whenever options dialog closes.
PamPanel	getSettingsPanel() Get panel which allows users to change settings for results filter.
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
boolean	isResultOk(SLResult slResult) Check whether a static localiser result is valid i.e.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setParams() Call this every time the panel is asked for to set params.

Methods inherited from class java.lang.Object

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

Method Detail

getAnalysisName

public java.lang.String getAnalysisName()

Description copied from interface: SLResultsAnalysis

Get the name

Specified by:

getAnalysisName in interface SLResultsAnalysis

Returns:

isResultOk

public boolean isResultOk(SLResult slResult)

Description copied from interface: SLResultsAnalysis

Check whether a static localiser result is valid i.e. passes whatever tests this filter uses.

Specified by:

isResultOk in interface SLResultsAnalysis

setParams

public void setParams()

Call this every time the panel is asked for to set params.

getSettingsPanel

public PamPanel getSettingsPanel()

Description copied from interface: SLResultsAnalysis

Get panel which allows users to change settings for results filter. Called whenever options dialog is opened and this filter selected.

Specified by:

getSettingsPanel in interface SLResultsAnalysis

Returns:

panel allowing users to change settings of filter. Can be null if no panel is needed.

getParams

public boolean getParams()

Description copied from interface: SLResultsAnalysis

Called whenever options dialog closes.

Specified by:

getParams in interface SLResultsAnalysis

Returns:

returns true if params successfully set from inputted data.

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