Package com.irurueta.navigation.inertial.calibration.magnetometer

Class MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

java.lang.Object
com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownMagneticFluxDensityNormMagnetometerCalibrator
com.irurueta.navigation.inertial.calibration.magnetometer.MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
All Implemented Interfaces:
MagnetometerCalibrator, MagnetometerNonLinearCalibrator, OrderedStandardDeviationBodyMagneticFluxDensityMagnetometerCalibrator, QualityScoredMagnetometerCalibrator, UnknownHardIronMagnetometerCalibrator, UnknownHardIronNonLinearMagnetometerCalibrator
public class MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator extends RobustKnownMagneticFluxDensityNormMagnetometerCalibrator
Robustly estimates magnetometer hard-iron biases, cross couplings and scaling factors using MSAC algorithm.

To use this calibrator at least 10 measurements with known magnetic field norm at an unknown position and instant must be taken at 10 different unknown orientations when common z-axis is assumed, otherwise at least 13 measurements are required.

Measured magnetic flux density is assumed to follow the model shown below: 

     mBmeas = bm + (I + Mm) * mBtrue + w
Where: - mBmeas is the measured magnetic flux density. This is a 3x1 vector. - bm is magnetometer hard-iron bias. Ideally, on a perfect magnetometer, this should be a 3x1 zero vector. - I is the 3x3 identity matrix. - Mm is the 3x3 soft-iron matrix containing cross-couplings and scaling factors. Ideally, on a perfect magnetometer, this should be a 3x3 zero matrix. - mBtrue is ground-truth magnetic flux density. This is a 3x1 vector. - w is measurement noise. This is a 3x1 vector. Notice that this calibrator assumes that all measurements are taken in a short span of time, where Earth magnetic field can be assumed to be constant at provided location and instant.

  • Field Details

    • DEFAULT_THRESHOLD

      public static final double DEFAULT_THRESHOLD
      Constant defining default threshold to determine whether samples are inliers or not.
      See Also:

    • MIN_THRESHOLD

      public static final double MIN_THRESHOLD
      Minimum value that can be set as threshold. Threshold must be strictly greater than 0.0.
      See Also:

    • threshold

      private double threshold
      Threshold to determine whether samples are inliers or not when testing possible estimation solutions.

  • Constructor Details

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator()
      Constructor.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      listener - listener to handle events raised by this calibrator.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements)
      Constructor.
      Parameters:
      measurements - list of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(boolean commonAxisUsed)
      Constructor.
      Parameters:
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] initialHardIron)
      Constructor.
      Parameters:
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(com.irurueta.algebra.Matrix initialHardIron)
      Constructor.
      Parameters:
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm)
      Constructor.
      Parameters:
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      measurements - list of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      listener - listener to handle events raised by this calibrator.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      listener - listener to handle events raised by this calibrator.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, boolean commonAxisUsed)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, double[] initialHardIron)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator

      public MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      measurements - collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      initialHardIron - initial hard-iron to find a solution.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

  • Method Details

    • getThreshold

      public double getThreshold()
      Returns threshold to determine whether samples are inliers or not.
      Returns:
      threshold to determine whether samples are inliers or not.

    • setThreshold

      public void setThreshold(double threshold) throws com.irurueta.navigation.LockedException
      Sets threshold to determine whether samples are inliers or not.
      Parameters:
      threshold - threshold to be set.
      Throws:
      IllegalArgumentException - if provided value is equal or less than zero.
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • calibrate

      public void calibrate() throws com.irurueta.navigation.LockedException, com.irurueta.navigation.NotReadyException, CalibrationException
      Estimates magnetometer calibration parameters containing hard-iron bias and soft-iron scale factors and cross-coupling errors.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.
      com.irurueta.navigation.NotReadyException - if calibrator is not ready.
      CalibrationException - if estimation fails for numerical reasons.

    • getMethod

      public com.irurueta.numerical.robust.RobustEstimatorMethod getMethod()
      Returns method being used for robust estimation.
      Specified by:
      getMethod in class RobustKnownMagneticFluxDensityNormMagnetometerCalibrator
      Returns:
      method being used for robust estimation.

    • isQualityScoresRequired

      public boolean isQualityScoresRequired()
      Indicates whether this calibrator requires quality scores for each measurement or not.
      Returns:
      true if quality scores are required, false otherwise.