Array

Class SimpleHydrophoneLocator

java.lang.Object

Array.HydrophoneLocator

Array.SimpleHydrophoneLocator

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

MovingHydrophoneLocator, StaticHydrophoneLocator

public abstract class SimpleHydrophoneLocator
extends HydrophoneLocator

Some abstract class function for hydrophone location that are used by more concrete locators, in particular the StaticHydrophoneLocator and StraightHydrophoneLocators

Author:

Doug Gillespie

See Also:

StraightHydrophoneLocator, StaticHydrophoneLocator, Serialized Form

Field Summary

Fields inherited from class Array.HydrophoneLocator

ANGLE_RE_ARRAY, ANGLE_RE_NORTH, ANGLE_RE_SHIP

Constructor Summary

Constructors

Constructor and Description
SimpleHydrophoneLocator(PamArray pamArray, Streamer streamer)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	getArrayHeading(GpsData gpsData) Return the heading in degrees of the hydrophone array
double[]	getHydrophoneCoordinateErrors(int iHydrophone, long timeMilliseconds) Get the hydrophone coordinate errors as a three element (x,y,z) vector.
double[]	getHydrophoneCoordinates(int iHydrophone, long timeMilliseconds) Get the hydrophone coordinates as a three element (x,y,z) vector referenced to the nominal array position (GPS for towed systems, a fixed point, etc.)
double	getPairAngle(long timeMilliseconds, int phone1, int phone2, int angleType) Get's the angle between a pair of hydrophones
double	getPairSeparation(long timeMilliseconds, int phone1, int phone2) Gets the angle between a pair of hydrophones in degrees in navigation units, i.e.
double	getPhoneHeading(long timeMilliseconds, int phoneNo)
double	getPhoneHeight(long timeMilliseconds, int phoneNo) Get's the depth of a specific hydrophone at a given time.
double	getPhoneTilt(long timeMilliseconds, int phoneNo) Get's the tilt of a specific hydrophone at a given time.
boolean	isChangeable() Note- changeable refers to the array positions changing relative to each other.
boolean	isStatic()
void	notifyModelChanged(int changeType, boolean initComplete)

Methods inherited from class Array.HydrophoneLocator

getArrayHeading, getDefaultSettings, getLocatorSettings, getName, getPhoneLatLong, getReferenceLatLong, setLocatorSettings

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleHydrophoneLocator

public SimpleHydrophoneLocator(PamArray pamArray,
                       Streamer streamer)

Method Detail

getPairAngle

public double getPairAngle(long timeMilliseconds,
                  int phone1,
                  int phone2,
                  int angleType)

Description copied from class: HydrophoneLocator

Get's the angle between a pair of hydrophones

Specified by:

getPairAngle in class HydrophoneLocator

Parameters:

timeMilliseconds - time angle is needed for

phone1 - First hydrophone

phone2 - Second Hydrophone

angleType - Type of angle - ANGLE_RE_NORTH; ANGLE_RE_SHIP; ANGLE_RE_ARRAY;

Returns:

angle in radians

getPairSeparation

public double getPairSeparation(long timeMilliseconds,
                       int phone1,
                       int phone2)

Gets the angle between a pair of hydrophones in degrees in navigation units, i.e. clockwise from North

Specified by:

getPairSeparation in class HydrophoneLocator

Parameters:

h1 - first hydrophone

h2 - second hydrophone

Returns:

angle from north in degrees

getPhoneHeight

public double getPhoneHeight(long timeMilliseconds,
                    int phoneNo)

Description copied from class: HydrophoneLocator

Get's the depth of a specific hydrophone at a given time.

Specified by:

getPhoneHeight in class HydrophoneLocator

Parameters:

timeMilliseconds - time depth needed for

phoneNo - Hydrophone number

Returns:

Hydrophone depth

getPhoneTilt

public double getPhoneTilt(long timeMilliseconds,
                  int phoneNo)

Description copied from class: HydrophoneLocator

Get's the tilt of a specific hydrophone at a given time.

Specified by:

getPhoneTilt in class HydrophoneLocator

Parameters:

timeMilliseconds - time tilt needed for

phoneNo - Hydrophone number

Returns:

Hydrophone tilt

getPhoneHeading

public double getPhoneHeading(long timeMilliseconds,
                     int phoneNo)

notifyModelChanged

public void notifyModelChanged(int changeType,
                      boolean initComplete)

Specified by:

notifyModelChanged in class HydrophoneLocator

isStatic

public boolean isStatic()

Specified by:

isStatic in class HydrophoneLocator

Returns:

true if it's some sort of static array (not using GPS data in any way).

getHydrophoneCoordinates

public double[] getHydrophoneCoordinates(int iHydrophone,
                                long timeMilliseconds)

Description copied from class: HydrophoneLocator

Get the hydrophone coordinates as a three element (x,y,z) vector referenced to the nominal array position (GPS for towed systems, a fixed point, etc.)

Hydrophone locators which want to vary location as a function of time should override this function and use the timeMilliseconds parameter to get the true location of the hydrophones in their own way.

Specified by:

getHydrophoneCoordinates in class HydrophoneLocator

Parameters:

iHydrophone - hydrophone number

timeMilliseconds - time of location

Returns:

three element position vector.

getHydrophoneCoordinateErrors

public double[] getHydrophoneCoordinateErrors(int iHydrophone,
                                     long timeMilliseconds)

Description copied from class: HydrophoneLocator

Get the hydrophone coordinate errors as a three element (x,y,z) vector.

Hydrophone locators which want to vary this error as a function of time should override this function and use the timeMilliseconds parameter to get the true errors in their own way.

Specified by:

getHydrophoneCoordinateErrors in class HydrophoneLocator

Parameters:

iHydrophone - hydrophone number

timeMilliseconds - time of location

Returns:

three element error vector.

getArrayHeading

public java.lang.Double getArrayHeading(GpsData gpsData)

Description copied from class: HydrophoneLocator

Return the heading in degrees of the hydrophone array

Specified by:

getArrayHeading in class HydrophoneLocator

Returns:

heading in DEGREES. Can return null;

isChangeable

public boolean isChangeable()

Description copied from class: HydrophoneLocator

Note- changeable refers to the array positions changing relative to each other. i.e. the array doesn't change with heading or gps position, it's only changeable if the distances between hydrophones can change with time.

Specified by:

isChangeable in class HydrophoneLocator

Returns:

true if the hydrophone positions within the array can change with time