clickDetector
Class ClickLocalisation

java.lang.Object
  PamDetection.AbstractLocalisation
      clickDetector.ClickLocalisation

public class ClickLocalisation
extends AbstractLocalisation

Field Summary

private double[][]	anglesAndErrors
private boolean	bearingAmbiguity
(package private) ClickDetection	clickDataUnit
private double	delayCorrection
private int	firstDelay

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

ClickLocalisation(ClickDetection parentDetection, int locContents, int referenceHydrophones, int subArrayType, PamVector[] arrayOrientation)

Method Summary

boolean	bearingAmbiguity()
double[]	getAngles()
double[][]	getAnglesAndErrors()
double	getBearing(int iSide) Get the bearing in radians, relative to the bearing reference
double	getBearingReference() Get the reference bearing in radians.
double	getDelayCorrection()
int	getFirstDelay()
void	setAngles(double[] angles)
void	setAnglesAndErrors(double[][] anglesAndErrors)
void	setDelayCorrection(double delayCorrection)
void	setFirstDelay(int delay)

Methods inherited from class PamDetection.AbstractLocalisation

addLocContents, getArrayOrientationVectors, getBearing, getBearingError, getBearingError, getDepth, getDepth, getDepthError, getDepthError, getErrorDirection, getLatLong, getLocContents, getNumLatLong, getOriginLatLong, getParallelError, getParentDetection, getPerpendiculaError, getPlanarAngles, getRange, 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

clickDataUnit

ClickDetection clickDataUnit

firstDelay

private int firstDelay

anglesAndErrors

private double[][] anglesAndErrors

delayCorrection

private double delayCorrection

bearingAmbiguity

private boolean bearingAmbiguity

Constructor Detail

ClickLocalisation

public ClickLocalisation(ClickDetection parentDetection,
                         int locContents,
                         int referenceHydrophones,
                         int subArrayType,
                         PamVector[] arrayOrientation)

Method Detail

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.

getBearing

public double getBearing(int iSide)

Description copied from class: AbstractLocalisation

Get the bearing in radians, relative to the bearing reference

Overrides:

getBearing in class AbstractLocalisation

Parameters:

iSide - which side is the bearing on

Returns:

bearing in radians

See Also:

getBearingReference

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.

getFirstDelay

public int getFirstDelay()

setFirstDelay

public void setFirstDelay(int delay)

getDelayCorrection

public double getDelayCorrection()

setDelayCorrection

public void setDelayCorrection(double delayCorrection)

setAnglesAndErrors

public void setAnglesAndErrors(double[][] anglesAndErrors)

Parameters:

anglesAndErrors - the anglesAndErrors 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.

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.

setAngles

public void setAngles(double[] angles)

getAnglesAndErrors

public double[][] getAnglesAndErrors()

Returns:

the anglesAndErrors