Array

Class MasterLocator

java.lang.Object

Array.HydrophoneLocator

Array.MasterLocator

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MasterLocator
extends HydrophoneLocator
implements java.io.Serializable, java.lang.Cloneable

Master PAMGuard array localiser. There is now one of these and of no other type within each PamArray and this will call out to different Localisers dependent on which channel is being used.

Author:

Doug Gillespie

See Also:

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
MasterLocator(PamArray pamArray) Individual locators will not be serialised.

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	getArrayHeading(long timeMilliseconds, int phoneNo) Get the heading of the array at the given time.
LocatorSettings	getDefaultSettings()
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.)
LocatorSettings	getLocatorSettings()
java.lang.String	getName()
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 distance between a pair of hydrophones in metres.
double	getPhoneHeight(long timeMilliseconds, int phoneNo) Get's the depth of a specific hydrophone at a given time.
GpsData	getPhoneLatLong(long timeMilliseconds, int phoneNo) Get's the LatLong 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.
GpsData	getReferenceLatLong(long timeMilliseconds) Gets a reference LatLong for the locator 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)
boolean	setLocatorSettings(LocatorSettings unusedSettings) This is used a bit differently in the master locator since it's passed null, but will have an array list of settings from when it was deserialized which it must pass on to the other locators.

Methods inherited from class java.lang.Object

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

Constructor Detail

MasterLocator

public MasterLocator(PamArray pamArray)

Individual locators will not be serialised.

Method Detail

getReferenceLatLong

public GpsData getReferenceLatLong(long timeMilliseconds)

Description copied from class: HydrophoneLocator

Gets a reference LatLong for the locator at a given time. For towed hydrophones, this will be the ships GPS position at that moment. For static phones it will be the static array reference position.

Specified by:

getReferenceLatLong in class HydrophoneLocator

Parameters:

timeMilliseconds - time reference needed for

Returns:

Reference LatLonbg

getPhoneLatLong

public GpsData getPhoneLatLong(long timeMilliseconds,
                      int phoneNo)

Description copied from class: HydrophoneLocator

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

Specified by:

getPhoneLatLong in class HydrophoneLocator

Parameters:

timeMilliseconds - time position needed for

phoneNo - Hydrophone number

Returns:

Hydrophone LatLong

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

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)

Description copied from class: HydrophoneLocator

Gets the distance between a pair of hydrophones in metres.

Specified by:

getPairSeparation in class HydrophoneLocator

Parameters:

timeMilliseconds - time angle is needed for

phone1 - First hydrophone

phone2 - Second Hydrophone

Returns:

distance in metres.

notifyModelChanged

public void notifyModelChanged(int changeType,
                      boolean initComplete)

Specified by:

notifyModelChanged in class HydrophoneLocator

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;

getArrayHeading

public double getArrayHeading(long timeMilliseconds,
                     int phoneNo)

Description copied from class: HydrophoneLocator

Get the heading of the array at the given time.

Specified by:

getArrayHeading in class HydrophoneLocator

phoneNo - Hydrophone number (the array may be heading in different directions at different places !)

Returns:

Heading in standard navigation units of degrees clockwise from North.

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).

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

getLocatorSettings

public LocatorSettings getLocatorSettings()

Specified by:

getLocatorSettings in class HydrophoneLocator

setLocatorSettings

public boolean setLocatorSettings(LocatorSettings unusedSettings)

This is used a bit differently in the master locator since it's passed null, but will have an array list of settings from when it was deserialized which it must pass on to the other locators.

Specified by:

setLocatorSettings in class HydrophoneLocator

getName

public java.lang.String getName()

Specified by:

getName in class HydrophoneLocator

getDefaultSettings

public LocatorSettings getDefaultSettings()

Specified by:

getDefaultSettings in class HydrophoneLocator