Package Array

Class Hydrophone

java.lang.Object
Array.Hydrophone
All Implemented Interfaces:
Serializable, Cloneable, ManagedParameters
public class Hydrophone extends Object implements 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 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

      protected PamVector getVector()
      Returns:
      the coordinates in vector form. s

    • getErrorVector

      protected PamVector 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

      protected Hydrophone clone()
      Overrides:
      clone in class Object

    • getType

      public String 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

      protected void setType(String type)
      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

      protected PamSymbol getSymbol()

    • setSymbol

      protected void setSymbol(PamSymbol symbol)

    • getStreamerId

      public int getStreamerId()

    • setStreamerId

      public void setStreamerId(int streamerId)

    • getTimeMillis

      public long getTimeMillis()

    • setTimeMillis

      public void setTimeMillis(long timeMillis)

    • weightedAverage

      public static Hydrophone weightedAverage(Hydrophone h1, Hydrophone h2, double w1, double w2)
      the weighted average of two hydrophones.
      Parameters:
      h1 -
      h2 -
      w1 -
      w2 -
      Returns:

    • getParameterSet

      public PamParameterSet getParameterSet()
      Description copied from interface: ManagedParameters
      Get a set of data that describes all of the parameters in a class
      Specified by:
      getParameterSet in interface ManagedParameters
      Returns:
      description of the parameters in a class.