Package beamformer.loc

Class BeamFormerLocalisation

java.lang.Object

PamDetection.AbstractLocalisation

beamformer.loc.BeamFormerLocalisation

All Implemented Interfaces:

Cloneable

public class BeamFormerLocalisation
extends AbstractLocalisation
implements Cloneable

Constructor Summary

Constructors

Constructor	Description
BeamFormerLocalisation(PamDataUnit pamDataUnit, int locContents, int referenceHydrophones, double[] angles, double angleError)

Method Summary

Modifier and Type	Method	Description
BeamFormerLocalisation	clone()
double[]	getAngleErrors()
double[]	getAngles()

Methods inherited from class PamDetection.AbstractLocalisation

addLocContents, bearingAmbiguity, getAmbiguityCount, 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

Constructor Details

BeamFormerLocalisation

public BeamFormerLocalisation(PamDataUnit pamDataUnit,
 int locContents,
 int referenceHydrophones,
 double[] angles,
 double angleError)

Method Details

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.

getAngleErrors

public double[] getAngleErrors()

Overrides:

getAngleErrors in class AbstractLocalisation

Returns:

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

For a point array, null should be returned.

For a line array a single error 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 errors should be returned, the first being the error on colatitude, the second being the longitude which will be between 0 and pi for a planar array and either -pi to pi or 0 to 2pi for a volumetric array.

clone

public BeamFormerLocalisation clone()