Package Array
Class Hydrophone
java.lang.Object
Array.Hydrophone
- All Implemented Interfaces:
Serializable
,Cloneable
,ManagedParameters
- Author:
- Doug Gillespie Contains information on a single hydrophone
Significant changes are being made to Hydrophone and Array management in August 2012
to deal with a wider variety of array types and array localisation systems.
all functions in this class have now been made protected thereby restricting direct access to individual hydrophone information to the PamArray class. The PamArray class will now work with it's array localiser to give hydrophone information - which will only be accessible through functions using a timestamp reference.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final long
-
Constructor Summary
ConstructorsConstructorDescriptionHydrophone
(int id) Hydrophone
(int id, double x, double y, double z, double xErr, double yErr, double zErr, String type, double sensitivity, double[] bandwidth, double preampGain) Hydrophone
(int id, double x, double y, double z, String type, double sensitivity, double[] bandwidth, double preampGain) -
Method Summary
Modifier and TypeMethodDescriptionprotected Hydrophone
clone()
double[]
protected double
getCoordinate
(int c) Get's a coordinate of the arraydouble
getCoordinateError
(int iCoordinate) Get the error on one of the three coordinates.protected double[]
double[]
double
getdX()
double
getdY()
double
getdZ()
protected PamVector
double[]
Do not use this function except in hydrphone locators in order to get nominal information.int
getID()
Get a set of data that describes all of the parameters in a classdouble
double
int
protected PamSymbol
long
getType()
protected PamVector
double
getX()
double
getY()
protected double
getY
(double depth) Get the hydrophone distance astern, corrected for hydrophone depth.double
getZ()
protected void
setBandwidth
(double[] bandwidth) protected void
setCoordinate
(double[] coordinate) protected void
setCoordinateError
(int iCoordinate, double error) Set the coordinate error on one of the three dimensions.protected void
setCoordinateErrors
(double[] errors) Set the coordinate error array.void
setdX
(double error) Set the error on the hydrophone x coordinatevoid
setdY
(double error) Set the error on the hydrophone y coordinatevoid
setdZ
(double error) Set the error on the hydrophone z coordinatevoid
setID
(int id) void
setPreampGain
(double preampGain) void
setSensitivity
(double sensitivity) void
setStreamerId
(int streamerId) protected void
void
setTimeMillis
(long timeMillis) protected void
void
setX
(double x) void
setY
(double y) void
setZ
(double z) static Hydrophone
weightedAverage
(Hydrophone h1, Hydrophone h2, double w1, double w2) the weighted average of two hydrophones.
-
Field Details
-
Constructor Details
-
Hydrophone
public Hydrophone(int id) -
Hydrophone
public Hydrophone(int id, double x, double y, double z, String type, double sensitivity, double[] bandwidth, double preampGain) -
Hydrophone
public Hydrophone(int id, double x, double y, double z, double xErr, double yErr, double zErr, String type, double sensitivity, double[] bandwidth, double preampGain)
-
-
Method Details
-
getBandwidth
public double[] getBandwidth() -
setBandwidth
protected void setBandwidth(double[] bandwidth) -
getSensitivity
public double getSensitivity() -
setSensitivity
public void setSensitivity(double sensitivity) -
getCoordinateError
public double getCoordinateError(int iCoordinate) Get the error on one of the three coordinates.- Parameters:
iCoordinate
- coordinate (x = 0; y = 1; z = 2)- Returns:
- error in metres.
-
setCoordinateErrors
protected void setCoordinateErrors(double[] errors) Set the coordinate error array.- Parameters:
errors
- array of errors on x,y,z
-
setCoordinateError
protected void setCoordinateError(int iCoordinate, double error) Set the coordinate error on one of the three dimensions.- Parameters:
iCoordinate
- coordinate (x = 0; y = 1; z = 2)error
- error in metres.
-
getCoordinateErrors
protected double[] getCoordinateErrors() -
getdX
public double getdX()- Returns:
- error on the hydrophone x coordinate.
-
setdX
public void setdX(double error) Set the error on the hydrophone x coordinate- Parameters:
error
- error in metres.
-
getdY
public double getdY()- Returns:
- error on the hydrophone y coordinate.
-
setdY
public void setdY(double error) Set the error on the hydrophone y coordinate- Parameters:
error
- error in metres.
-
getdZ
public double getdZ()- Returns:
- error on the hydrophone depth coordinate.
-
setdZ
public void setdZ(double error) Set the error on the hydrophone z coordinate- Parameters:
error
- error in metres.
-
getX
public double getX() -
setX
public void setX(double x) -
getY
public double getY() -
getVector
- Returns:
- the coordinates in vector form. s
-
getErrorVector
- Returns:
- the coordinate errors in vector form.
-
getY
protected double getY(double depth) Get the hydrophone distance astern, corrected for hydrophone depth.- Parameters:
depth
-- Returns:
- corrected y coordinate.
-
setY
public void setY(double y) -
getZ
public double getZ() -
setZ
public void setZ(double z) -
getCoordinate
protected double getCoordinate(int c) Get's a coordinate of the array- Parameters:
c
- index of the coordinate (0 = x; 1 = y; 2 = z)- Returns:
- coordinate value
-
clone
-
getType
-
getCoordinates
public double[] getCoordinates()- Returns:
- Returns the coordinate.
-
getHiddenCoordinates
public double[] getHiddenCoordinates()Do not use this function except in hydrphone locators in order to get nominal information. this will be removed after debug of new system !- Returns:
-
setCoordinate
protected void setCoordinate(double[] coordinate) - Parameters:
coordinate
- The coordinate to set.
-
getPreampGain
public double getPreampGain()- Returns:
- Returns the preampGain.
-
setPreampGain
public void setPreampGain(double preampGain) - Parameters:
preampGain
- The preampGain to set.
-
setType
- Parameters:
type
- The type to set.
-
getID
public int getID()- Returns:
- Returns the iD.
-
setID
public void setID(int id) - Parameters:
id
- The iD to set.
-
getSymbol
-
setSymbol
-
getStreamerId
public int getStreamerId() -
setStreamerId
public void setStreamerId(int streamerId) -
getTimeMillis
public long getTimeMillis() -
setTimeMillis
public void setTimeMillis(long timeMillis) -
weightedAverage
the weighted average of two hydrophones.- Parameters:
h1
-h2
-w1
-w2
-- Returns:
-
getParameterSet
Description copied from interface:ManagedParameters
Get a set of data that describes all of the parameters in a class- Specified by:
getParameterSet
in interfaceManagedParameters
- Returns:
- description of the parameters in a class.
-