Package com.irurueta.navigation.inertial.calibration

Class StandardDeviationBodyMagneticFluxDensity

java.lang.Object
com.irurueta.navigation.inertial.calibration.StandardDeviationBodyMagneticFluxDensity
All Implemented Interfaces:
Serializable, Cloneable
public class StandardDeviationBodyMagneticFluxDensity extends Object implements Serializable, Cloneable
Contains a body magnetic flux density along with its corresponding standard deviation.
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:

    • magneticFluxDensity

      private BodyMagneticFluxDensity magneticFluxDensity
      Current body magnetic flux density. Contains magnetometer measurements.

    • magneticFluxDensityStandardDeviation

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

  • Constructor Details

    • StandardDeviationBodyMagneticFluxDensity

      public StandardDeviationBodyMagneticFluxDensity()
      Constructor.

    • StandardDeviationBodyMagneticFluxDensity

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

    • StandardDeviationBodyMagneticFluxDensity

      public StandardDeviationBodyMagneticFluxDensity(double magneticFluxDensityStandardDeviation)
      Constructor.
      Parameters:
      magneticFluxDensityStandardDeviation - standard deviation of measured magnetic flux density.
      Throws:
      IllegalArgumentException - if provided standard deviation is negative.

    • StandardDeviationBodyMagneticFluxDensity

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

    • StandardDeviationBodyMagneticFluxDensity

      public StandardDeviationBodyMagneticFluxDensity(StandardDeviationBodyMagneticFluxDensity input)
      Constructor.
      Parameters:
      input - instance to copy data from.

  • Method Details

    • getMagneticFluxDensity

      public BodyMagneticFluxDensity getMagneticFluxDensity()
      Gets current body magnetic flux density. Contains magnetometer measurements.
      Returns:
      current body magnetic flux density.

    • setMagneticFluxDensity

      public void setMagneticFluxDensity(BodyMagneticFluxDensity magneticFluxDensity)
      Sets current body magnetic flux density. Contains magnetometer measurements.
      Parameters:
      magneticFluxDensity - current body magnetic flux density.

    • 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(StandardDeviationBodyMagneticFluxDensity input)
      Copies data of provided instance into this instance.
      Parameters:
      input - instance to copy data from.

    • copyTo

      public void copyTo(StandardDeviationBodyMagneticFluxDensity 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 Object
      Returns:
      Hash code.

    • equals

      public boolean equals(StandardDeviationBodyMagneticFluxDensity 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(StandardDeviationBodyMagneticFluxDensity 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 magnetic flux density and standard deviation value.
      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 StandardDeviationBodyMagneticFluxDensity instance having exactly the same contents as this instance.
      Overrides:
      equals in class Object
      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 Object
      Returns:
      a copy of this instance.
      Throws:
      CloneNotSupportedException - if clone fails for some reason.