clickDetector
Class ClickTrainLocalisation

java.lang.Object
  PamDetection.AbstractLocalisation
      clickDetector.ClickTrainLocalisation

public class ClickTrainLocalisation
extends AbstractLocalisation

Field Summary

(package private) ClickTrainDetection	clickTrainDataUnit
(package private) double	referenceBearing

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

ClickTrainLocalisation(ClickTrainDetection parentDetection, int referenceHydrophones)

Method Summary

boolean	bearingAmbiguity()
double	getBearing(int iSide) Get the bearing in radians, relative to the bearing reference
double	getBearingReference() Get the reference bearing in radians.
int	getLocContents()
double	getRange(int iSide) Get the range for a specific side (where ambiguity exists)
void	setReferenceBearing(double referenceBearing)

Methods inherited from class PamDetection.AbstractLocalisation

addLocContents, getAngles, getArrayOrientationVectors, getBearing, getBearingError, getBearingError, getDepth, getDepth, getDepthError, getDepthError, getErrorDirection, getLatLong, 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

clickTrainDataUnit

ClickTrainDetection clickTrainDataUnit

referenceBearing

double referenceBearing

Constructor Detail

ClickTrainLocalisation

public ClickTrainLocalisation(ClickTrainDetection parentDetection,
                              int referenceHydrophones)

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

getLocContents

public int getLocContents()

Overrides:

getLocContents in class AbstractLocalisation

Returns:

a set of flags specifying which data are available within this localisation object.

getRange

public double getRange(int iSide)

Description copied from class: AbstractLocalisation

Get the range for a specific side (where ambiguity exists)

Overrides:

getRange in class AbstractLocalisation

Returns:

range

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.

setReferenceBearing

public void setReferenceBearing(double referenceBearing)