whistlesAndMoans
Class WhistleBearingInfo

java.lang.Object
  extended by PamDetection.AbstractLocalisation
      extended by whistlesAndMoans.WhistleBearingInfo

public class WhistleBearingInfo
extends AbstractLocalisation


Field Summary
(package private)  double[][] anglesAndErrors
           
(package private)  PamVector[] arrayAxis
           
(package private)  double bearingRef
           
 
Fields inherited from class PamDetection.AbstractLocalisation
HAS_AMBIGUITY, HAS_BEARING, HAS_BEARINGERROR, HAS_DEPTH, HAS_DEPTHERROR, HAS_LATLONG, HAS_PERPENDICULARERRORS, HAS_RANGE, HAS_RANGEERROR, HAS_XY, HAS_XYZ
 
Constructor Summary
WhistleBearingInfo(PamDataUnit pamDataUnit, BearingLocaliser bearingLocaliser, int hydrophones, double[][] anglesAndErrors)
           
 
Method Summary
 boolean bearingAmbiguity()
           
 double[] getAngles()
           
 double getBearingReference()
          Get the reference bearing in radians.
 double getRange(int side)
          Get the range for a specific side (where ambiguity exists)
 
Methods inherited from class PamDetection.AbstractLocalisation
addLocContents, getArrayOrientationVectors, getBearing, getBearing, getBearingError, getBearingError, getDepth, getDepth, getDepthError, getDepthError, getErrorDirection, getLatLong, getLocContents, getNumLatLong, getOriginLatLong, getParallelError, getParentDetection, getPerpendiculaError, getPlanarAngles, getRange, getRangeError, getRangeError, getReferenceHydrophones, getSubArrayType, hasLocContent, removeLocContents, setLocContents, setParentDetection, setReferenceHydrophones
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

anglesAndErrors

double[][] anglesAndErrors

arrayAxis

PamVector[] arrayAxis

bearingRef

double bearingRef
Constructor Detail

WhistleBearingInfo

public WhistleBearingInfo(PamDataUnit pamDataUnit,
                          BearingLocaliser bearingLocaliser,
                          int hydrophones,
                          double[][] anglesAndErrors)
Method Detail

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.

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 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 volumetirc array.


getBearingReference

public double getBearingReference()
Description copied from class: AbstractLocalisation
Get the reference bearing in radians. This is relative to North, moving in a clockwise direction as would other bearings

Overrides:
getBearingReference in class AbstractLocalisation
Returns:
Reference bearing in radians.

bearingAmbiguity

public boolean bearingAmbiguity()
Overrides:
bearingAmbiguity in class AbstractLocalisation
Returns:
true if the bearing is subject to a left right (or rotational) ambiguity about the reference bearing.

getRange

public double getRange(int side)
Description copied from class: AbstractLocalisation
Get the range for a specific side (where ambiguity exists)

Overrides:
getRange in class AbstractLocalisation
Returns:
range