Class MLGridBearingLocaliser
java.lang.Object
Localiser.algorithms.timeDelayLocalisers.bearingLoc.MLGridBearingLocaliser
- All Implemented Interfaces:
BearingLocaliser
,LocalisationAlgorithm
,LocalisationAlgorithmInfo
Deprecated.
Maximum likelihood bearing localiser to get bearings from a closely
spaced hydrophone array.
Deprecated August 2017 in switch to new coordinate frame. See MLGridBearingLocaliser2.
- Author:
- Doug Gillespie.
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Get information about the localisation algorithm.Deprecated.Get the algorithm nameDeprecated.Get the principle axis of the arrayint
Deprecated.int
Deprecated.Get a hydrophone map for this localiserint
Deprecated.Get the likely content flags for this localiser.getLocalizationOptionsPanel
(Window parent, LocalizationBuilder locBuilder) Deprecated.Get options panel to either build into the export dialog or to show as a separate dialog (in which case export wizard will show a button).Deprecated.Get the algorithm parameters.Deprecated.Get something that can make LocalisationType objects of a form a bit bespoke to the type of localiser.double[][]
localise
(double[] delays, long timeMillis) Deprecated.Calculate angles theta and phi, based on a set of delays.double[][]
localiseByBisection
(double[] delays) Deprecated.double[][]
localiseByCrawl
(double[] delays, long timeMillis) Deprecated.void
prepare
(int[] arrayElements, long timMillis, double timingError) Deprecated.Do any preparation necessary (e.g.
-
Method Details
-
prepare
public void prepare(int[] arrayElements, long timMillis, double timingError) Deprecated.Description copied from interface:BearingLocaliser
Do any preparation necessary (e.g. creation of look up tables)- Specified by:
prepare
in interfaceBearingLocaliser
- Parameters:
arrayElements
- list of hydrophone array elements in the sub array for this localiser.timMillis
- , current time for this localisationtimingError
- expected timing error for each measurement (typically 1/12 of an ADC bin, or less if interpolation is being used in the cross correlation function).
-
getLocalisationContents
public int getLocalisationContents()Deprecated.Description copied from interface:LocalisationAlgorithmInfo
Get the likely content flags for this localiser.- Specified by:
getLocalisationContents
in interfaceLocalisationAlgorithmInfo
- Returns:
- localisation flags.
- See Also:
-
getArrayAxis
Deprecated.Description copied from interface:BearingLocaliser
Get the principle axis of the array- Specified by:
getArrayAxis
in interfaceBearingLocaliser
- Returns:
- for a linear array this will be a vector along the array;
for a planar array, this will be the vector on the plane between two hydrophones which is closest to the y axis.
-
getArrayType
public int getArrayType()Deprecated.- Specified by:
getArrayType
in interfaceBearingLocaliser
- Returns:
- the type of array - linear, planar, volumetric, etc.
-
localise
public double[][] localise(double[] delays, long timeMillis) Deprecated.Description copied from interface:BearingLocaliser
Calculate angles theta and phi, based on a set of delays. The number of delays should be equal to n(n-1)/2 where n is the number of hydrophone elements in the sub array.- Specified by:
localise
in interfaceBearingLocaliser
- Parameters:
delays
- array of delay times.timeMillis
- of this detection. This is relatively unused except in situation where hydrophone elements are moving relative to each other with time.- Returns:
- theta, phi and their estimated errors all in radians.
Data are packed into a two row array, the first row of which contains one or two angles, the second (optional) row contains the errors on those angles.
-
localiseByCrawl
public double[][] localiseByCrawl(double[] delays, long timeMillis) Deprecated. -
localiseByBisection
public double[][] localiseByBisection(double[] delays) Deprecated. -
getHydrophoneMap
public int getHydrophoneMap()Deprecated.Description copied from interface:BearingLocaliser
Get a hydrophone map for this localiser- Specified by:
getHydrophoneMap
in interfaceBearingLocaliser
- Returns:
- bitmap of used hydrophones.
-
getAlgorithmName
Deprecated.Description copied from interface:LocalisationAlgorithmInfo
Get the algorithm name- Specified by:
getAlgorithmName
in interfaceLocalisationAlgorithmInfo
- Returns:
- algorithm name
-
getParameters
Deprecated.Description copied from interface:LocalisationAlgorithmInfo
Get the algorithm parameters. Something else can turn these into xml for Tethys.- Specified by:
getParameters
in interfaceLocalisationAlgorithmInfo
- Returns:
- algorithm parameters object. Might be null;
-
getAlgorithmInfo
Deprecated.Description copied from interface:LocalisationAlgorithm
Get information about the localisation algorithm.- Specified by:
getAlgorithmInfo
in interfaceLocalisationAlgorithm
- Returns:
- algorithm information.
-
getTethysCreator
Deprecated.Description copied from interface:LocalisationAlgorithm
Get something that can make LocalisationType objects of a form a bit bespoke to the type of localiser. This may be better than having the standard functions in LocalizationBuilder guess what's best.- Specified by:
getTethysCreator
in interfaceLocalisationAlgorithm
- Returns:
- can be null in which case standard functions will do the best they can.
-
getLocalizationOptionsPanel
public LocalizationOptionsPanel getLocalizationOptionsPanel(Window parent, LocalizationBuilder locBuilder) Deprecated.Description copied from interface:LocalisationAlgorithmInfo
Get options panel to either build into the export dialog or to show as a separate dialog (in which case export wizard will show a button). Can be null if no options.- Specified by:
getLocalizationOptionsPanel
in interfaceLocalisationAlgorithmInfo
- Parameters:
locBuilder
-- Returns:
- options panel or null if there are no options.
-