Class StandardDeviationFrameBodyMagneticFluxDensity

java.lang.Object
com.irurueta.navigation.inertial.calibration.FrameBodyMagneticFluxDensity
com.irurueta.navigation.inertial.calibration.StandardDeviationFrameBodyMagneticFluxDensity
All Implemented Interfaces:
Serializable, Cloneable

public class StandardDeviationFrameBodyMagneticFluxDensity extends FrameBodyMagneticFluxDensity
Extension of FrameBodyMagneticFluxDensity containing standard deviations of measured magnetic flux densities besides their corresponding frame (position and orientation) and timestamp where measurement was made.
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serialization version. This is used to ensure compatibility of deserialization of permanently stored serialized instances.
      See Also:
    • magneticFluxDensityStandardDeviation

      private double magneticFluxDensityStandardDeviation
      Standard deviation of measured magnetic flux density expressed in Teslas (T).
  • Constructor Details

    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity()
      Constructor.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.ECEFFrame frame)
      Constructor.
      Parameters:
      frame - current ECEF frame associated to measurement.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.NEDFrame frame)
      Constructor.
      Parameters:
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.ECEFFrame frame)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current ECEF frame associated to measurement.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.NEDFrame frame)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(double year)
      Constructor.
      Parameters:
      year - time expressed as decimal year.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, double year)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      year - time expressed as decimal year.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.ECEFFrame frame, double year)
      Constructor.
      Parameters:
      frame - current ECEF frame associated to measurement.
      year - time expressed as decimal year.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.NEDFrame frame, double year)
      Constructor.
      Parameters:
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      year - time expressed as decimal year.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.ECEFFrame frame, double year)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current ECEF frame associated to measurement.
      year - time expressed as decimal year.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.NEDFrame frame, double year)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      year - time expressed as decimal year.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(Date time)
      Constructor.
      Parameters:
      time - a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, Date time)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      time - a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.ECEFFrame frame, Date time)
      Constructor.
      Parameters:
      frame - current ECEF frame associated to measurement.
      time - a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.NEDFrame frame, Date time)
      Constructor.
      Parameters:
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      time - a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.ECEFFrame frame, Date time)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current ECEF frame associated to measurement.
      time - a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.NEDFrame frame, Date time)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      time - a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(GregorianCalendar calendar)
      Constructor.
      Parameters:
      calendar - calendar containing a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, GregorianCalendar calendar)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      calendar - calendar containing a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.ECEFFrame frame, GregorianCalendar calendar)
      Constructor.
      Parameters:
      frame - current ECEF frame associated to measurement.
      calendar - calendar containing a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.NEDFrame frame, GregorianCalendar calendar)
      Constructor.
      Parameters:
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      calendar - calendar containing a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.ECEFFrame frame, GregorianCalendar calendar)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current ECEF frame associated to measurement.
      calendar - calendar containing a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.NEDFrame frame, GregorianCalendar calendar)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      calendar - calendar containing a timestamp.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(double year, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      year - time expressed as decimal year.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, double year, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      year - time expressed as decimal year.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.ECEFFrame frame, double year, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      frame - current ECEF frame associated to measurement.
      year - time expressed as decimal year.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.NEDFrame frame, double year, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      year - time expressed as decimal year.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.ECEFFrame frame, double year, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current ECEF frame associated to measurement.
      year - time expressed as decimal year.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.NEDFrame frame, double year, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      year - time expressed as decimal year.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(Date time, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      time - a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, Date time, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      time - a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.ECEFFrame frame, Date time, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      frame - current ECEF frame associated to measurement.
      time - a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.NEDFrame frame, Date time, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      time - a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.ECEFFrame frame, Date time, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current ECEF frame associated to measurement.
      time - a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.NEDFrame frame, Date time, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      time - a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(GregorianCalendar calendar, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      calendar - calendar containing a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, GregorianCalendar calendar, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      calendar - calendar containing a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.ECEFFrame frame, GregorianCalendar calendar, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      frame - current ECEF frame associated to measurement.
      calendar - calendar containing a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(com.irurueta.navigation.frames.NEDFrame frame, GregorianCalendar calendar, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      calendar - calendar containing a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.ECEFFrame frame, GregorianCalendar calendar, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current ECEF frame associated to measurement.
      calendar - calendar containing a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity, com.irurueta.navigation.frames.NEDFrame frame, GregorianCalendar calendar, double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.
      frame - current NED frame associated to measurement. Internally it will be converted to its corresponding ECEF frame.
      calendar - calendar containing a timestamp.
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.
    • StandardDeviationFrameBodyMagneticFluxDensity

      public StandardDeviationFrameBodyMagneticFluxDensity(StandardDeviationFrameBodyMagneticFluxDensity input)
      Constructor.
      Parameters:
      input - instance to copy data from.
  • Method Details

    • getMagneticFluxDensityStandardDeviation

      public double getMagneticFluxDensityStandardDeviation()
      Gets standard deviation of measured magnetic flux density expressed in Teslas (T).
      Returns:
      standard deviation of measured magnetic flux density.
    • setMagneticFluxDensityStandardDeviation

      public void setMagneticFluxDensityStandardDeviation(double magneticFluxDensityStandardDeviation)
      Sets standard deviation of measured magnetic flux density expressed in Teslas (T).
      Parameters:
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided value is negative.
    • copyFrom

      public void copyFrom(StandardDeviationFrameBodyMagneticFluxDensity input)
      Copies data of provided instance into this instance.
      Parameters:
      input - instance to copy data from.
    • copyTo

      public void copyTo(StandardDeviationFrameBodyMagneticFluxDensity output)
      Copies this instance data into provided instance.
      Parameters:
      output - destination instance where data will be copied to.
    • hashCode

      public int hashCode()
      Computes and returns hash code for this instance. Hash codes are almost unique values that are useful for fast classification and storage of objects in collections.
      Overrides:
      hashCode in class FrameBodyMagneticFluxDensity
      Returns:
      Hash code.
    • equals

      public boolean equals(StandardDeviationFrameBodyMagneticFluxDensity other)
      Checks if provided instance has exactly the same contents as this instance.
      Parameters:
      other - instance to be compared.
      Returns:
      true if both instances are considered to be equal, false otherwise.
    • equals

      public boolean equals(StandardDeviationFrameBodyMagneticFluxDensity other, double threshold)
      Checks if provided instance has contents similar to this instance up to provided threshold value.
      Parameters:
      other - instance to be compared.
      threshold - maximum allowed difference between values.
      Returns:
      true if both instances are considered to be equal (up to provided threshold), false otherwise.
    • equals

      public boolean equals(FrameBodyMagneticFluxDensity other, double threshold)
      Checks if provided instance has contents similar to this instance up to provided threshold value.
      Overrides:
      equals in class FrameBodyMagneticFluxDensity
      Parameters:
      other - instance to be compared.
      threshold - maximum allowed difference between magnetic flux density and frame values.
      Returns:
      true if both instances are considered to be equal (up to provided threshold), false otherwise.
    • equals

      public boolean equals(Object obj)
      Checks if provided object is a StandardDeviationFrameBodyMagneticFluxDensity instance having exactly the same contents as this instance.
      Overrides:
      equals in class FrameBodyMagneticFluxDensity
      Parameters:
      obj - object to be compared.
      Returns:
      true if both objects are considered to be equal, false otherwise.
    • clone

      protected Object clone() throws CloneNotSupportedException
      Makes a copy of this instance.
      Overrides:
      clone in class FrameBodyMagneticFluxDensity
      Returns:
      a copy of this instance.
      Throws:
      CloneNotSupportedException - if clone fails for some reason.