Package beamformer.plot

Class BeamOGramLocalisation

java.lang.Object

PamDetection.AbstractLocalisation

beamformer.plot.BeamOGramLocalisation

public class BeamOGramLocalisation
extends AbstractLocalisation

Field Summary

Fields

Modifier and Type	Field	Description
static final int	locCont

Constructor Summary

Constructors

Constructor	Description
BeamOGramLocalisation(BeamOGramDataUnit boDataUnit, int referenceHydrophones, double bestAngle)

Method Summary

Modifier and Type	Method	Description
double[]	getAngles()
double	getBestAngle()
void	setBestAngle(double bestAngle)

Methods inherited from class PamDetection.AbstractLocalisation

addLocContents, bearingAmbiguity, getAmbiguityCount, getAngleErrors, getArrayOrientationVectors, getBearing, getBearing, getBearingError, getBearingReference, getDepth, getErrorDirection, getHeight, getHeightError, getLatLong, getLocContents, getLocError, getNumLatLong, getOriginLatLong, getParallelError, getParentDetection, getPerpendiculaError, getPlanarAngles, getPlanarVector, getRange, getRangeError, getRealWorldVectors, getReferenceHydrophones, getSubArrayType, getTimeDelayChIndex, getTimeDelayErrors, getTimeDelays, getWorldVectors, hasLocContent, removeLocContents, setArrayAxis, setLocContents, setParentDetection, setReferenceHydrophones, setSubArrayType, toString

Methods inherited from class java.lang.Object

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

Field Details

locCont

public static final int locCont

See Also:

• Constant Field Values

Constructor Details

BeamOGramLocalisation

public BeamOGramLocalisation(BeamOGramDataUnit boDataUnit,
 int referenceHydrophones,
 double bestAngle)

Method Details

getBestAngle

public double getBestAngle()

Returns:

the bestAngle

setBestAngle

public void setBestAngle(double bestAngle)

Parameters:

bestAngle - the bestAngle to set

getAngles

public double[] getAngles()

Overrides:

getAngles in class AbstractLocalisation

Returns:

Angles to detection in radians. The number of angles will be 0, 1 or 2.

***************** CHANGES FROM AUGUST 2017 *******************
Now oriented the 'globe' differently, so that the first angle can be between -Pi and +Pi or between 0 and 2Pi. The second angle is the elevation angle which is either up (+ve angles) or down (-ve angles) having a range of -Pi/2 to +Pi/2. This change will only affect data from volumetric arrays when the animal is at significant depth. Changes are being made to data from click and whistle detectors which used the older system to maintain compatibility.

For a point array, null should be returned.

For a line array a single angle is returned which is the angle relative to the first orientation vector with 0 being in line with the orientation vector (can be thought of as colatitude).

For a planar or volumetric array, two angles should be returned, the first being the colongitude, the second being the latitude. Imagine a globe, with North vertical and 0 longitude pointing along the main axis of the array geometry.