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

Class RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

java.lang.Object
com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator
All Implemented Interfaces:
KnownHardIronMagnetometerCalibrator, MagnetometerCalibrator, MagnetometerNonLinearCalibrator, OrderedStandardDeviationBodyMagneticFluxDensityMagnetometerCalibrator, QualityScoredMagnetometerCalibrator
Direct Known Subclasses:
LMedSRobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator, MSACRobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator, PROMedSRobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator, PROSACRobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator, RANSACRobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator
public abstract class RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator extends Object implements MagnetometerNonLinearCalibrator, KnownHardIronMagnetometerCalibrator, OrderedStandardDeviationBodyMagneticFluxDensityMagnetometerCalibrator, QualityScoredMagnetometerCalibrator
This is an abstract class to robustly estimate magnetometer cross couplings and scaling factors.

To use this calibrator at least 7 measurements taken at a single unknown position and instant must be taken at 7 different unknown orientations when common z-axis is assumed, otherwise at least 10 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_USE_COMMON_Z_AXIS

      public static final boolean DEFAULT_USE_COMMON_Z_AXIS
      Indicates whether by default a common z-axis is assumed for the accelerometer, gyroscope and magnetometer.
      See Also:

    • MINIMUM_MEASUREMENTS_COMMON_Z_AXIS

      public static final int MINIMUM_MEASUREMENTS_COMMON_Z_AXIS
      Required minimum number of measurements when common z-axis is assumed.
      See Also:

    • MINIMUM_MEASUREMENTS_GENERAL

      public static final int MINIMUM_MEASUREMENTS_GENERAL
      Required minimum number of measurements for the general case.
      See Also:

    • DEFAULT_ROBUST_METHOD

      public static final com.irurueta.numerical.robust.RobustEstimatorMethod DEFAULT_ROBUST_METHOD
      Default robust estimator method when none is provided.

    • DEFAULT_REFINE_RESULT

      public static final boolean DEFAULT_REFINE_RESULT
      Indicates that result is refined by default.
      See Also:

    • DEFAULT_KEEP_COVARIANCE

      public static final boolean DEFAULT_KEEP_COVARIANCE
      Indicates that covariance is kept by default after refining result.
      See Also:

    • DEFAULT_PROGRESS_DELTA

      public static final float DEFAULT_PROGRESS_DELTA
      Default amount of progress variation before notifying a change in estimation progress. By default this is set to 5%.
      See Also:

    • MIN_PROGRESS_DELTA

      public static final float MIN_PROGRESS_DELTA
      Minimum allowed value for progress delta.
      See Also:

    • MAX_PROGRESS_DELTA

      public static final float MAX_PROGRESS_DELTA
      Maximum allowed value for progress delta.
      See Also:

    • DEFAULT_CONFIDENCE

      public static final double DEFAULT_CONFIDENCE
      Constant defining default confidence of the estimated result, which is 99%. This means that with a probability of 99% estimation will be accurate because chosen sub-samples will be inliers.
      See Also:

    • DEFAULT_MAX_ITERATIONS

      public static final int DEFAULT_MAX_ITERATIONS
      Default maximum allowed number of iterations.
      See Also:

    • MIN_CONFIDENCE

      public static final double MIN_CONFIDENCE
      Minimum allowed confidence value.
      See Also:

    • MAX_CONFIDENCE

      public static final double MAX_CONFIDENCE
      Maximum allowed confidence value.
      See Also:

    • MIN_ITERATIONS

      public static final int MIN_ITERATIONS
      Minimum allowed number of iterations.
      See Also:

    • measurements

      protected List<StandardDeviationBodyMagneticFluxDensity> measurements
      Contains a list of body magnetic flux density measurements taken at a given position with different unknown orientations and containing the standard deviation of magnetometer measurements.

    • listener

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener
      Listener to be notified of events such as when calibration starts, ends or its progress significantly changes.

    • running

      protected boolean running
      Indicates whether estimator is running.

    • progressDelta

      protected float progressDelta
      Amount of progress variation before notifying a progress change during calibration.

    • confidence

      protected double confidence
      Amount of confidence expressed as a value between 0.0 and 1.0 (which is equivalent to 100%). The amount of confidence indicates the probability that the estimated result is correct. Usually this value will be close to 1.0, but not exactly 1.0.

    • maxIterations

      protected int maxIterations
      Maximum allowed number of iterations. When the maximum number of iterations is exceeded, result will not be available, however an approximate result will be available for retrieval.

    • inliersData

      protected com.irurueta.numerical.robust.InliersData inliersData
      Data related to inlier found after calibration.

    • refineResult

      protected boolean refineResult
      Indicates whether result must be refined using a non linear calibrator over found inliers. If true, inliers will be computed and kept in any implementation regardless of the settings.

    • preliminarySubsetSize

      protected int preliminarySubsetSize
      Size of subsets to be checked during robust estimation.

    • commonAxisUsed

      private boolean commonAxisUsed
      This flag indicates whether z-axis is assumed to be common for accelerometer, gyroscope and magnetometer. When enabled, this eliminates 3 variables from soft-iron (Mm) matrix.

    • estimatedMm

      private com.irurueta.algebra.Matrix estimatedMm
      Estimated magnetometer soft-iron matrix containing scale factors and cross coupling errors. This is the product of matrix Tm containing cross coupling errors and Km containing scaling factors. So tat: 
           Mm = [sx    mxy  mxz] = Tm*Km
          [myx   sy   myz]
          [mzx   mzy  sz ]
      Where: 
           Km = [sx 0   0 ]
          [0  sy  0 ]
          [0  0   sz]
      and 
           Tm = [1          -alphaXy    alphaXz ]
          [alphaYx    1           -alphaYz]
          [-alphaZx   alphaZy     1       ]
      Hence: 
           Mm = [sx    mxy  mxz] = Tm*Km =  [sx             -sy * alphaXy   sz * alphaXz ]
          [myx   sy   myz]            [sx * alphaYx   sy              -sz * alphaYz]
          [mzx   mzy  sz ]            [-sx * alphaZx  sy * alphaZy    sz           ]
      This instance allows any 3x3 matrix however, typically alphaYx, alphaZx and alphaZy are considered to be zero if the accelerometer z-axis is assumed to be the same as the body z-axis. When this is assumed, myx = mzx = mzy = 0 and the Mm matrix becomes upper diagonal: 
           Mm = [sx    mxy  mxz]
          [0     sy   myz]
          [0     0    sz ]
      Values of this matrix are unit-less.

    • keepCovariance

      private boolean keepCovariance
      Indicates whether covariance must be kept after refining result. This setting is only taken into account if result is refined.

    • estimatedCovariance

      private com.irurueta.algebra.Matrix estimatedCovariance
      Estimated covariance matrix for estimated parameters.

    • estimatedChiSq

      private double estimatedChiSq
      Estimated chi square value.

    • estimatedChiSqDegreesOfFreedom

      private int estimatedChiSqDegreesOfFreedom
      Estimated degrees of freedom of chi square value. Degrees of freedom is equal to the number of sampled data minus the number of estimated parameters.

    • estimatedReducedChiSq

      private double estimatedReducedChiSq
      Estimated reduced chi square value. This is equal to estimated chi square value divided by its degrees of freedom. Ideally this value should be close to 1.0.

    • estimatedMse

      private double estimatedMse
      Estimated mean square error respect to provided measurements.

    • estimatedP

      private double estimatedP
      Estimated probability of finding a smaller chi square value expressed as a value between 0.0 and 1.0. The smaller the found chi square value is, the better the fit of the estimated parameters to the actual parameter. Thus, the smaller the chance of finding a smaller chi square value, then the better the estimated fit is.

    • estimatedQ

      private double estimatedQ
      Estimated measure of quality of estimated fit as a value between 0.0 and 1.0. The larger the quality value is, the better the fit that has been estimated.

    • hardIronX

      private double hardIronX
      Known x-coordinate of hard-iron bias to be used to find a solution. This is expressed in Teslas (T).

    • hardIronY

      private double hardIronY
      Known y-coordinate of hard-iron bias to be used to find a solution. This is expressed in Teslas (T).

    • hardIronZ

      private double hardIronZ
      Known z-coordinate of hard-iron bias to be used to find a solution. This is expressed in Teslas (T).

    • initialSx

      private double initialSx
      Initial x scaling factor.

    • initialSy

      private double initialSy
      Initial y scaling factor.

    • initialSz

      private double initialSz
      Initial z scaling factor.

    • initialMxy

      private double initialMxy
      Initial x-y cross coupling error.

    • initialMxz

      private double initialMxz
      Initial x-z cross coupling error.

    • initialMyx

      private double initialMyx
      Initial y-x cross coupling error.

    • initialMyz

      private double initialMyz
      Initial y-z cross coupling error.

    • initialMzx

      private double initialMzx
      Initial z-x cross coupling error.

    • initialMzy

      private double initialMzy
      Initial z-y cross coupling error.

    • groundTruthMagneticFluxDensityNorm

      protected Double groundTruthMagneticFluxDensityNorm
      Ground truth magnetic flux density norm to be expected at location where measurements have been made, expressed in Teslas (T).

    • innerCalibrator

      private final KnownHardIronMagneticFluxDensityNormMagnetometerCalibrator innerCalibrator
      Inner calibrator to compute calibration for each subset of data or during final refining.

    • identity

      protected com.irurueta.algebra.Matrix identity
      Contains 3x3 identify to be reused.

    • tmp1

      protected com.irurueta.algebra.Matrix tmp1
      Contains 3x3 temporary matrix.

    • tmp2

      protected com.irurueta.algebra.Matrix tmp2
      Contains 3x3 temporary matrix.

    • tmp3

      protected com.irurueta.algebra.Matrix tmp3
      Contains 3x1 temporary matrix.

    • tmp4

      protected com.irurueta.algebra.Matrix tmp4
      Contains 3x1 temporary matrix.

  • Constructor Details

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator()
      Constructor.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Constructor.
      Parameters:
      listener - listener to handle events raised by this calibrator.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

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

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(double[] hardIron)
      Constructor.
      Parameters:
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(com.irurueta.algebra.Matrix hardIron)
      Constructor.
      Parameters:
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Constructor.
      Parameters:
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron)
      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.
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron)
      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.
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron)
      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.
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron)
      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.
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, double[] hardIron)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Constructor.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron)
      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.
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron)
      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.
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron)
      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.
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron)
      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.
      hardIron - known hard-iron.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known 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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, 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.
      hardIron - known hard-iron.
      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.

    • RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator

      protected RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener 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.
      hardIron - known hard-iron.
      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

    • getGroundTruthMagneticFluxDensityNorm

      public Double getGroundTruthMagneticFluxDensityNorm()
      Gets ground truth magnetic flux density norm to be expected at location where measurements have been made, expressed in Teslas (T).
      Returns:
      ground truth magnetic flux density or null.

    • getGroundTruthMagneticFluxDensityNormAsMagneticFluxDensity

      public com.irurueta.units.MagneticFluxDensity getGroundTruthMagneticFluxDensityNormAsMagneticFluxDensity()
      Gets ground truth magnetic flux density norm to be expected at location where measurements have been made.
      Returns:
      ground truth magnetic flux density or null.

    • getGroundTruthMagneticFluxDensityNormAsMagneticFluxDensity

      public boolean getGroundTruthMagneticFluxDensityNormAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets ground truth magnetic flux density norm to be expected at location where measurements have been made.
      Parameters:
      result - instance where result will be stored.
      Returns:
      true if ground truth magnetic flux density norm has been defined, false if it is not available yet.

    • setGroundTruthMagneticFluxDensityNorm

      public void setGroundTruthMagneticFluxDensityNorm(Double groundTruthMagneticFluxDensityNorm) throws com.irurueta.navigation.LockedException
      Sets ground truth magnetic flux density norm to be expected at location where measurements have been made, expressed in Teslas (T).
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm or null if undefined.
      Throws:
      IllegalArgumentException - if provided value is negative.
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • setGroundTruthMagneticFluxDensityNorm

      public void setGroundTruthMagneticFluxDensityNorm(com.irurueta.units.MagneticFluxDensity groundTruthMagneticFluxDensityNorm) throws com.irurueta.navigation.LockedException
      Sets ground truth magnetic flux density norm to be expected at location where measurements have been made.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm or null if undefined.
      Throws:
      IllegalArgumentException - if provided value is negative.
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getHardIronX

      public double getHardIronX()
      Gets known x-coordinate of magnetometer hard-iron bias. This is expressed in Teslas (T).
      Specified by:
      getHardIronX in interface KnownHardIronMagnetometerCalibrator
      Returns:
      known x-coordinate of magnetometer hard-iron bias.

    • setHardIronX

      public void setHardIronX(double hardIronX) throws com.irurueta.navigation.LockedException
      Sets known x-coordinate of magnetometer hard-iron bias. This is expressed in Teslas (T).
      Specified by:
      setHardIronX in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIronX - known x-coordinate of magnetometer hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getHardIronY

      public double getHardIronY()
      Gets known y-coordinate of magnetometer hard-iron bias. This is expressed in Teslas (T).
      Specified by:
      getHardIronY in interface KnownHardIronMagnetometerCalibrator
      Returns:
      known y-coordinate of magnetometer hard-iron bias.

    • setHardIronY

      public void setHardIronY(double hardIronY) throws com.irurueta.navigation.LockedException
      Sets known y-coordinate of magnetometer hard-iron bias. This is expressed in Teslas (T).
      Specified by:
      setHardIronY in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIronY - known y-coordinate of magnetometer hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getHardIronZ

      public double getHardIronZ()
      Gets known z-coordinate of magnetometer hard-iron bias. This is expressed in Teslas (T).
      Specified by:
      getHardIronZ in interface KnownHardIronMagnetometerCalibrator
      Returns:
      known z-coordinate of magnetometer hard-iron bias.

    • setHardIronZ

      public void setHardIronZ(double hardIronZ) throws com.irurueta.navigation.LockedException
      Sets known z-coordinate of magnetometer hard-iron bias. This is expressed in meters Teslas (T).
      Specified by:
      setHardIronZ in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIronZ - known z-coordinate of magnetometer hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getHardIronXAsMagneticFluxDensity

      public com.irurueta.units.MagneticFluxDensity getHardIronXAsMagneticFluxDensity()
      Gets known x coordinate of magnetometer hard-iron.
      Specified by:
      getHardIronXAsMagneticFluxDensity in interface KnownHardIronMagnetometerCalibrator
      Returns:
      x coordinate of magnetometer hard-iron.

    • getHardIronXAsMagneticFluxDensity

      public void getHardIronXAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets known x coordinate of magnetometer hard-iron.
      Specified by:
      getHardIronXAsMagneticFluxDensity in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      result - instance where result will be stored.

    • setHardIronX

      public void setHardIronX(com.irurueta.units.MagneticFluxDensity hardIronX) throws com.irurueta.navigation.LockedException
      Sets known x-coordinate of magnetometer hard-iron.
      Specified by:
      setHardIronX in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIronX - known x-coordinate of magnetometer hard-iron.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getHardIronYAsMagneticFluxDensity

      public com.irurueta.units.MagneticFluxDensity getHardIronYAsMagneticFluxDensity()
      Gets known y coordinate of magnetometer hard-iron.
      Specified by:
      getHardIronYAsMagneticFluxDensity in interface KnownHardIronMagnetometerCalibrator
      Returns:
      y coordinate of magnetometer hard-iron.

    • getHardIronYAsMagneticFluxDensity

      public void getHardIronYAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets known y coordinate of magnetometer hard-iron.
      Specified by:
      getHardIronYAsMagneticFluxDensity in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      result - instance where result will be stored.

    • setHardIronY

      public void setHardIronY(com.irurueta.units.MagneticFluxDensity hardIronY) throws com.irurueta.navigation.LockedException
      Sets known y-coordinate of magnetometer hard-iron.
      Specified by:
      setHardIronY in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIronY - known y-coordinate of magnetometer hard-iron.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getHardIronZAsMagneticFluxDensity

      public com.irurueta.units.MagneticFluxDensity getHardIronZAsMagneticFluxDensity()
      Gets known z coordinate of magnetometer hard-iron.
      Specified by:
      getHardIronZAsMagneticFluxDensity in interface KnownHardIronMagnetometerCalibrator
      Returns:
      z coordinate of magnetometer hard-iron.

    • getHardIronZAsMagneticFluxDensity

      public void getHardIronZAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets known z coordinate of magnetometer hard-iron.
      Specified by:
      getHardIronZAsMagneticFluxDensity in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      result - instance where result will be stored.

    • setHardIronZ

      public void setHardIronZ(com.irurueta.units.MagneticFluxDensity hardIronZ) throws com.irurueta.navigation.LockedException
      Sets known z-coordinate of magnetometer hard-iron.
      Specified by:
      setHardIronZ in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIronZ - known z-coordinate of magnetometer hard-iron.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • setHardIronCoordinates

      public void setHardIronCoordinates(double hardIronX, double hardIronY, double hardIronZ) throws com.irurueta.navigation.LockedException
      Sets known hard-iron bias coordinates of magnetometer expressed in Teslas (T).
      Specified by:
      setHardIronCoordinates in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIronX - x-coordinate of magnetometer known hard-iron bias.
      hardIronY - y-coordinate of magnetometer known hard-iron bias.
      hardIronZ - z-coordinate of magnetometer known hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • setHardIronCoordinates

      public void setHardIronCoordinates(com.irurueta.units.MagneticFluxDensity hardIronX, com.irurueta.units.MagneticFluxDensity hardIronY, com.irurueta.units.MagneticFluxDensity hardIronZ) throws com.irurueta.navigation.LockedException
      Sets known hard-iron coordinates.
      Specified by:
      setHardIronCoordinates in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIronX - x-coordinate of magnetometer hard-iron.
      hardIronY - y-coordinate of magnetometer hard-iron.
      hardIronZ - z-coordinate of magnetometer hard-iron.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getHardIronAsTriad

      public MagneticFluxDensityTriad getHardIronAsTriad()
      Gets known hard-iron.
      Specified by:
      getHardIronAsTriad in interface KnownHardIronMagnetometerCalibrator
      Returns:
      known hard-iron.

    • getHardIronAsTriad

      public void getHardIronAsTriad(MagneticFluxDensityTriad result)
      Gets known hard-iron.
      Specified by:
      getHardIronAsTriad in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      result - instance where result will be stored.

    • setHardIron

      public void setHardIron(MagneticFluxDensityTriad hardIron) throws com.irurueta.navigation.LockedException
      Sets known hard-iron.
      Specified by:
      setHardIron in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIron - hard-iron to be set.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialSx

      public double getInitialSx()
      Gets initial x scaling factor.
      Specified by:
      getInitialSx in interface MagnetometerNonLinearCalibrator
      Returns:
      initial x scaling factor.

    • setInitialSx

      public void setInitialSx(double initialSx) throws com.irurueta.navigation.LockedException
      Sets initial x scaling factor.
      Specified by:
      setInitialSx in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialSx - initial x scaling factor.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialSy

      public double getInitialSy()
      Gets initial y scaling factor.
      Specified by:
      getInitialSy in interface MagnetometerNonLinearCalibrator
      Returns:
      initial y scaling factor.

    • setInitialSy

      public void setInitialSy(double initialSy) throws com.irurueta.navigation.LockedException
      Sets initial y scaling factor.
      Specified by:
      setInitialSy in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialSy - initial y scaling factor.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialSz

      public double getInitialSz()
      Gets initial z scaling factor.
      Specified by:
      getInitialSz in interface MagnetometerNonLinearCalibrator
      Returns:
      initial z scaling factor.

    • setInitialSz

      public void setInitialSz(double initialSz) throws com.irurueta.navigation.LockedException
      Sets initial z scaling factor.
      Specified by:
      setInitialSz in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialSz - initial z scaling factor.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialMxy

      public double getInitialMxy()
      Gets initial x-y cross coupling error.
      Specified by:
      getInitialMxy in interface MagnetometerNonLinearCalibrator
      Returns:
      initial x-y cross coupling error.

    • setInitialMxy

      public void setInitialMxy(double initialMxy) throws com.irurueta.navigation.LockedException
      Sets initial x-y cross coupling error.
      Specified by:
      setInitialMxy in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialMxy - initial x-y cross coupling error.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialMxz

      public double getInitialMxz()
      Gets initial x-z cross coupling error.
      Specified by:
      getInitialMxz in interface MagnetometerNonLinearCalibrator
      Returns:
      initial x-z cross coupling error.

    • setInitialMxz

      public void setInitialMxz(double initialMxz) throws com.irurueta.navigation.LockedException
      Sets initial x-z cross coupling error.
      Specified by:
      setInitialMxz in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialMxz - initial x-z cross coupling error.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialMyx

      public double getInitialMyx()
      Gets initial y-x cross coupling error.
      Specified by:
      getInitialMyx in interface MagnetometerNonLinearCalibrator
      Returns:
      initial y-x cross coupling error.

    • setInitialMyx

      public void setInitialMyx(double initialMyx) throws com.irurueta.navigation.LockedException
      Sets initial y-x cross coupling error.
      Specified by:
      setInitialMyx in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialMyx - initial y-x cross coupling error.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialMyz

      public double getInitialMyz()
      Gets initial y-z cross coupling error.
      Specified by:
      getInitialMyz in interface MagnetometerNonLinearCalibrator
      Returns:
      initial y-z cross coupling error.

    • setInitialMyz

      public void setInitialMyz(double initialMyz) throws com.irurueta.navigation.LockedException
      Sets initial y-z cross coupling error.
      Specified by:
      setInitialMyz in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialMyz - initial y-z cross coupling error.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialMzx

      public double getInitialMzx()
      Gets initial z-x cross coupling error.
      Specified by:
      getInitialMzx in interface MagnetometerNonLinearCalibrator
      Returns:
      initial z-x cross coupling error.

    • setInitialMzx

      public void setInitialMzx(double initialMzx) throws com.irurueta.navigation.LockedException
      Sets initial z-x cross coupling error.
      Specified by:
      setInitialMzx in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialMzx - initial z-x cross coupling error.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialMzy

      public double getInitialMzy()
      Gets initial z-y cross coupling error.
      Specified by:
      getInitialMzy in interface MagnetometerNonLinearCalibrator
      Returns:
      initial z-y cross coupling error.

    • setInitialMzy

      public void setInitialMzy(double initialMzy) throws com.irurueta.navigation.LockedException
      Sets initial z-y cross coupling error.
      Specified by:
      setInitialMzy in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialMzy - initial z-y cross coupling error.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • setInitialScalingFactors

      public void setInitialScalingFactors(double initialSx, double initialSy, double initialSz) throws com.irurueta.navigation.LockedException
      Sets initial scaling factors.
      Specified by:
      setInitialScalingFactors in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialSx - initial x scaling factor.
      initialSy - initial y scaling factor.
      initialSz - initial z scaling factor.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • setInitialCrossCouplingErrors

      public void setInitialCrossCouplingErrors(double initialMxy, double initialMxz, double initialMyx, double initialMyz, double initialMzx, double initialMzy) throws com.irurueta.navigation.LockedException
      Sets initial cross coupling errors.
      Specified by:
      setInitialCrossCouplingErrors in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialMxy - initial x-y cross coupling error.
      initialMxz - initial x-z cross coupling error.
      initialMyx - initial y-x cross coupling error.
      initialMyz - initial y-z cross coupling error.
      initialMzx - initial z-x cross coupling error.
      initialMzy - initial z-y cross coupling error.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • setInitialScalingFactorsAndCrossCouplingErrors

      public void setInitialScalingFactorsAndCrossCouplingErrors(double initialSx, double initialSy, double initialSz, double initialMxy, double initialMxz, double initialMyx, double initialMyz, double initialMzx, double initialMzy) throws com.irurueta.navigation.LockedException
      Sets initial scaling factors and cross coupling errors.
      Specified by:
      setInitialScalingFactorsAndCrossCouplingErrors in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialSx - initial x scaling factor.
      initialSy - initial y scaling factor.
      initialSz - initial z scaling factor.
      initialMxy - initial x-y cross coupling error.
      initialMxz - initial x-z cross coupling error.
      initialMyx - initial y-x cross coupling error.
      initialMyz - initial y-z cross coupling error.
      initialMzx - initial z-x cross coupling error.
      initialMzy - initial z-y cross coupling error.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getHardIron

      public double[] getHardIron()
      Gets known hard-iron bias as an array. Array values are expressed in Teslas (T).
      Specified by:
      getHardIron in interface KnownHardIronMagnetometerCalibrator
      Returns:
      array containing coordinates of known bias.

    • getHardIron

      public void getHardIron(double[] result)
      Gets known hard-iron bias as an array. Array values are expressed in Teslas (T).
      Specified by:
      getHardIron in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      result - instance where result data will be copied to.
      Throws:
      IllegalArgumentException - if provided array does not have length 3.

    • setHardIron

      public void setHardIron(double[] hardIron) throws com.irurueta.navigation.LockedException
      Sets known hard-iron bias as an array. Array values are expressed in Teslas (T).
      Specified by:
      setHardIron in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIron - known hard-iron.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.
      IllegalArgumentException - if provided array does not have length 3.

    • getHardIronMatrix

      public com.irurueta.algebra.Matrix getHardIronMatrix()
      Gets known hard-iron bias as a column matrix.
      Specified by:
      getHardIronMatrix in interface KnownHardIronMagnetometerCalibrator
      Returns:
      known hard-iron bias as a column matrix.

    • getHardIronMatrix

      public void getHardIronMatrix(com.irurueta.algebra.Matrix result)
      Gets known hard-iron bias as a column matrix.
      Specified by:
      getHardIronMatrix in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      result - instance where result data will be copied to.
      Throws:
      IllegalArgumentException - if provided matrix is not 3x1.

    • setHardIron

      public void setHardIron(com.irurueta.algebra.Matrix hardIron) throws com.irurueta.navigation.LockedException
      Sets known hard-iron bias as a column matrix.
      Specified by:
      setHardIron in interface KnownHardIronMagnetometerCalibrator
      Parameters:
      hardIron - known hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.
      IllegalArgumentException - if provided matrix is not 3x1.

    • getInitialMm

      public com.irurueta.algebra.Matrix getInitialMm()
      Gets initial scale factors and cross coupling errors matrix.
      Specified by:
      getInitialMm in interface MagnetometerNonLinearCalibrator
      Returns:
      initial scale factors and cross coupling errors matrix.

    • getInitialMm

      public void getInitialMm(com.irurueta.algebra.Matrix result)
      Gets initial scale factors and cross coupling errors matrix.
      Specified by:
      getInitialMm in interface MagnetometerNonLinearCalibrator
      Parameters:
      result - instance where data will be stored.
      Throws:
      IllegalArgumentException - if provided matrix is not 3x3.

    • setInitialMm

      public void setInitialMm(com.irurueta.algebra.Matrix initialMm) throws com.irurueta.navigation.LockedException
      Sets initial scale factors and cross coupling errors matrix.
      Specified by:
      setInitialMm in interface MagnetometerNonLinearCalibrator
      Parameters:
      initialMm - initial scale factors and cross coupling errors matrix.
      Throws:
      IllegalArgumentException - if provided matrix is not 3x3.
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getMeasurements

      public List<StandardDeviationBodyMagneticFluxDensity> getMeasurements()
      Gets collection of body magnetic flux density measurements taken at a given position with different unknown orientations and containing the standard deviation of magnetometer measurements.
      Specified by:
      getMeasurements in interface OrderedStandardDeviationBodyMagneticFluxDensityMagnetometerCalibrator
      Returns:
      collection of body magnetic flux density measurements at a known position and timestamp with unknown orientations.

    • setMeasurements

      public void setMeasurements(List<StandardDeviationBodyMagneticFluxDensity> measurements) throws com.irurueta.navigation.LockedException
      Sets collection of body magnetic flux density measurements taken at a given position with different unknown orientations and containing the standard deviation of magnetometer measurements.
      Specified by:
      setMeasurements in interface OrderedStandardDeviationBodyMagneticFluxDensityMagnetometerCalibrator
      Parameters:
      measurements - collection of body magnetic flux density measurements at a known position and timestamp with unknown orientations.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getMeasurementType

      public MagnetometerCalibratorMeasurementType getMeasurementType()
      Indicates the type of measurement used by this calibrator.
      Specified by:
      getMeasurementType in interface MagnetometerCalibrator
      Returns:
      type of measurement used by this calibrator.

    • isOrderedMeasurementsRequired

      public boolean isOrderedMeasurementsRequired()
      Indicates whether this calibrator requires ordered measurements in a list or not.
      Specified by:
      isOrderedMeasurementsRequired in interface MagnetometerCalibrator
      Returns:
      true if measurements must be ordered, false otherwise.

    • isCommonAxisUsed

      public boolean isCommonAxisUsed()
      Indicates whether z-axis is assumed to be common for accelerometer, gyroscope and magnetometer. When enabled, this eliminates 3 variables from Mm (soft-iron) matrix.
      Specified by:
      isCommonAxisUsed in interface MagnetometerCalibrator
      Returns:
      true if z-axis is assumed to be common for accelerometer, gyroscope and magnetometer, false otherwise.

    • setCommonAxisUsed

      public void setCommonAxisUsed(boolean commonAxisUsed) throws com.irurueta.navigation.LockedException
      Specifies whether z-axis is assumed to be common for accelerometer and gyroscope. When enabled, this eliminates 3 variables from Mm matrix.
      Specified by:
      setCommonAxisUsed in interface MagnetometerCalibrator
      Parameters:
      commonAxisUsed - true if z-axis is assumed to be common for accelerometer, gyroscope and magnetometer, false otherwise.
      Throws:
      com.irurueta.navigation.LockedException - if estimator is currently running.

    • getListener

      public RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener getListener()
      Gets listener to handle events raised by this calibrator.
      Returns:
      listener to handle events raised by this calibrator.

    • setListener

      public void setListener(RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener) throws com.irurueta.navigation.LockedException
      Sets listener to handle events raised by this calibrator.
      Parameters:
      listener - listener to handle events raised by this calibrator.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getMinimumRequiredMeasurements

      public int getMinimumRequiredMeasurements()
      Gets minimum number of required measurements.
      Specified by:
      getMinimumRequiredMeasurements in interface MagnetometerCalibrator
      Returns:
      minimum number of required measurements.

    • isReady

      public boolean isReady()
      Indicates whether calibrator is ready to start the estimator.
      Specified by:
      isReady in interface MagnetometerCalibrator
      Returns:
      true if calibrator is ready, false otherwise.

    • isRunning

      public boolean isRunning()
      Indicates whether calibrator is currently running or no.
      Specified by:
      isRunning in interface MagnetometerCalibrator
      Returns:
      true if calibrator is running, false otherwise.

    • getProgressDelta

      public float getProgressDelta()
      Returns amount of progress variation before notifying a progress change during calibration.
      Returns:
      amount of progress variation before notifying a progress change during calibration.

    • setProgressDelta

      public void setProgressDelta(float progressDelta) throws com.irurueta.navigation.LockedException
      Sets amount of progress variation before notifying a progress change during calibration.
      Parameters:
      progressDelta - amount of progress variation before notifying a progress change during calibration.
      Throws:
      IllegalArgumentException - if progress delta is less than zero or greater than 1.
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getConfidence

      public double getConfidence()
      Returns amount of confidence expressed as a value between 0.0 and 1.0 (which is equivalent to 100%). The amount of confidence indicates the probability that the estimated result is correct. Usually this value will be close to 1.0, but not exactly 1.0.
      Returns:
      amount of confidence as a value between 0.0 and 1.0.

    • setConfidence

      public void setConfidence(double confidence) throws com.irurueta.navigation.LockedException
      Sets amount of confidence expressed as a value between 0.0 and 1.0 (which is equivalent to 100%). The amount of confidence indicates the probability that the estimated result is correct. Usually this value will be close to 1.0, but not exactly 1.0.
      Parameters:
      confidence - confidence to be set as a value between 0.0 and 1.0.
      Throws:
      IllegalArgumentException - if provided value is not between 0.0 and 1.0.
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getMaxIterations

      public int getMaxIterations()
      Returns maximum allowed number of iterations. If maximum allowed number of iterations is achieved without converging to a result when calling calibrate(), a RobustEstimatorException will be raised.
      Returns:
      maximum allowed number of iterations.

    • setMaxIterations

      public void setMaxIterations(int maxIterations) throws com.irurueta.navigation.LockedException
      Sets maximum allowed number of iterations. When the maximum number of iterations is exceeded, result will not be available, however an approximate result will be available for retrieval.
      Parameters:
      maxIterations - maximum allowed number of iterations to be set.
      Throws:
      IllegalArgumentException - if provided value is less than 1.
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInliersData

      public com.irurueta.numerical.robust.InliersData getInliersData()
      Gets data related to inliers found after estimation.
      Returns:
      data related to inliers found after estimation.

    • isResultRefined

      public boolean isResultRefined()
      Indicates whether result must be refined using a non-linear solver over found inliers.
      Returns:
      true to refine result, false to simply use result found by robust estimator without further refining.

    • setResultRefined

      public void setResultRefined(boolean refineResult) throws com.irurueta.navigation.LockedException
      Specifies whether result must be refined using a non-linear solver over found inliers.
      Parameters:
      refineResult - true to refine result, false to simply use result found by robust estimator without further refining.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • isCovarianceKept

      public boolean isCovarianceKept()
      Indicates whether covariance must be kept after refining result. This setting is only taken into account if result is refined.
      Returns:
      true if covariance must be kept after refining result, false otherwise.

    • setCovarianceKept

      public void setCovarianceKept(boolean keepCovariance) throws com.irurueta.navigation.LockedException
      Specifies whether covariance must be kept after refining result. This setting is only taken into account if result is refined.
      Parameters:
      keepCovariance - true if covariance must be kept after refining result, false otherwise.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getQualityScores

      public double[] getQualityScores()
      Returns quality scores corresponding to each measurement. The larger the score value the better the quality of the sample. This implementation always returns null. Subclasses using quality scores must implement proper behavior.
      Specified by:
      getQualityScores in interface QualityScoredMagnetometerCalibrator
      Returns:
      quality scores corresponding to each sample.

    • setQualityScores

      public void setQualityScores(double[] qualityScores) throws com.irurueta.navigation.LockedException
      Sets quality scores corresponding to each measurement. The larger the score value the better the quality of the sample. This implementation makes no action. Subclasses using quality scores must implement proper behaviour.
      Specified by:
      setQualityScores in interface QualityScoredMagnetometerCalibrator
      Parameters:
      qualityScores - quality scores corresponding to each pair of matched points.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than minimum required samples.
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getEstimatedMm

      public com.irurueta.algebra.Matrix getEstimatedMm()
      Gets estimated magnetometer soft-iron matrix containing scale factors and cross coupling errors. This is the product of matrix Tm containing cross coupling errors and Km containing scaling factors. So tat: 
           Mm = [sx    mxy  mxz] = Tm*Km
          [myx   sy   myz]
          [mzx   mzy  sz ]
      Where: 
           Km = [sx 0   0 ]
          [0  sy  0 ]
          [0  0   sz]
      and 
           Tm = [1          -alphaXy    alphaXz ]
          [alphaYx    1           -alphaYz]
          [-alphaZx   alphaZy     1       ]
      Hence: 
           Mm = [sx    mxy  mxz] = Tm*Km =  [sx             -sy * alphaXy   sz * alphaXz ]
          [myx   sy   myz]            [sx * alphaYx   sy              -sz * alphaYz]
          [mzx   mzy  sz ]            [-sx * alphaZx  sy * alphaZy    sz           ]
      This instance allows any 3x3 matrix however, typically alphaYx, alphaZx and alphaZy are considered to be zero if the accelerometer z-axis is assumed to be the same as the body z-axis. When this is assumed, myx = mzx = mzy = 0 and the Mm matrix becomes upper diagonal: 
           Mm = [sx    mxy  mxz]
          [0     sy   myz]
          [0     0    sz ]
      Values of this matrix are unit-less.
      Specified by:
      getEstimatedMm in interface MagnetometerCalibrator
      Returns:
      estimated magnetometer soft-iron scale factors and cross coupling errors, or null if not available.

    • getEstimatedSx

      public Double getEstimatedSx()
      Gets estimated x-axis scale factor.
      Specified by:
      getEstimatedSx in interface MagnetometerCalibrator
      Returns:
      estimated x-axis scale factor or null if not available.

    • getEstimatedSy

      public Double getEstimatedSy()
      Gets estimated y-axis scale factor.
      Specified by:
      getEstimatedSy in interface MagnetometerCalibrator
      Returns:
      estimated y-axis scale factor or null if not available.

    • getEstimatedSz

      public Double getEstimatedSz()
      Gets estimated z-axis scale factor.
      Specified by:
      getEstimatedSz in interface MagnetometerCalibrator
      Returns:
      estimated z-axis scale factor or null if not available.

    • getEstimatedMxy

      public Double getEstimatedMxy()
      Gets estimated x-y cross-coupling error.
      Specified by:
      getEstimatedMxy in interface MagnetometerCalibrator
      Returns:
      estimated x-y cross-coupling error or null if not available.

    • getEstimatedMxz

      public Double getEstimatedMxz()
      Gets estimated x-z cross-coupling error.
      Specified by:
      getEstimatedMxz in interface MagnetometerCalibrator
      Returns:
      estimated x-z cross-coupling error or null if not available.

    • getEstimatedMyx

      public Double getEstimatedMyx()
      Gets estimated y-x cross-coupling error.
      Specified by:
      getEstimatedMyx in interface MagnetometerCalibrator
      Returns:
      estimated y-x cross-coupling error or null if not available.

    • getEstimatedMyz

      public Double getEstimatedMyz()
      Gets estimated y-z cross-coupling error.
      Specified by:
      getEstimatedMyz in interface MagnetometerCalibrator
      Returns:
      estimated y-z cross-coupling error or null if not available.

    • getEstimatedMzx

      public Double getEstimatedMzx()
      Gets estimated z-x cross-coupling error.
      Specified by:
      getEstimatedMzx in interface MagnetometerCalibrator
      Returns:
      estimated z-x cross-coupling error or null if not available.

    • getEstimatedMzy

      public Double getEstimatedMzy()
      Gets estimated z-y cross-coupling error.
      Specified by:
      getEstimatedMzy in interface MagnetometerCalibrator
      Returns:
      estimated z-y cross-coupling error or null if not available.

    • getEstimatedChiSq

      public double getEstimatedChiSq()
      Gets estimated chi square value.
      Specified by:
      getEstimatedChiSq in interface MagnetometerNonLinearCalibrator
      Returns:
      estimated chi square value.

    • getEstimatedChiSqDegreesOfFreedom

      public int getEstimatedChiSqDegreesOfFreedom()
      Gets estimated chi square degrees of freedom. Degrees of freedom is equal to the number of sampled data minus the number of estimated parameters.
      Specified by:
      getEstimatedChiSqDegreesOfFreedom in interface MagnetometerNonLinearCalibrator
      Returns:
      estimated degrees of freedom of chi square value

    • getEstimatedReducedChiSq

      public double getEstimatedReducedChiSq()
      Gets estimated reduced chi square value. This is equal to estimated chi square value divided by its degrees of freedom. Ideally this value should be close to 1.0, indicating that fit is optimal. A value larger than 1.0 indicates that fit is not good or noise has been underestimated, and a value smaller than 1.0 indicates that there is overfitting or noise has been overestimated.
      Specified by:
      getEstimatedReducedChiSq in interface MagnetometerNonLinearCalibrator
      Returns:
      estimated reduced chi square value

    • getEstimatedMse

      public double getEstimatedMse()
      Gets estimated mean square error respect to provided measurements.
      Specified by:
      getEstimatedMse in interface MagnetometerNonLinearCalibrator
      Returns:
      estimated mean square error respect to provided measurements.

    • getEstimatedP

      public double getEstimatedP()
      Gets estimated probability of finding a smaller chi square value expressed as a value between 0.0 and 1.0. The smaller the found chi square value is, the better the fit of the estimated parameters to the actual parameter. Thus, the smaller the chance of finding a smaller chi square value, then the better the estimated fit is.
      Specified by:
      getEstimatedP in interface MagnetometerNonLinearCalibrator
      Returns:
      estimated probability of finding a smaller chi square value.

    • getEstimatedQ

      public double getEstimatedQ()
      Gets estimated measure of quality of estimated fit as a value between 0.0 and 1.0. The larger the quality value is, the better the fit that has been estimated.
      Specified by:
      getEstimatedQ in interface MagnetometerNonLinearCalibrator
      Returns:
      estimated measure of quality of estimated fit.

    • getEstimatedCovariance

      public com.irurueta.algebra.Matrix getEstimatedCovariance()
      Gets estimated covariance matrix for estimated calibration parameters. Diagonal elements of the matrix contains variance for the following parameters (following indicated order): bx, by, bz, sx, sy, sz, mxy, mxz, myx, myz, mzx, mzy.
      Specified by:
      getEstimatedCovariance in interface MagnetometerNonLinearCalibrator
      Returns:
      estimated covariance matrix for estimated calibration parameters.

    • getPreliminarySubsetSize

      public int getPreliminarySubsetSize()
      Gets size of subsets to be checked during robust estimation. This has to be at least MINIMUM_MEASUREMENTS_COMMON_Z_AXIS.
      Returns:
      size of subsets to be checked during robust estimation.

    • setPreliminarySubsetSize

      public void setPreliminarySubsetSize(int preliminarySubsetSize) throws com.irurueta.navigation.LockedException
      Sets size of subsets to be checked during robust estimation. This has to be at least MINIMUM_MEASUREMENTS_COMMON_Z_AXIS.
      Parameters:
      preliminarySubsetSize - size of subsets to be checked during robust estimation.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.
      IllegalArgumentException - if provided value is less than MINIMUM_MEASUREMENTS_COMMON_Z_AXIS.

    • getMethod

      public abstract com.irurueta.numerical.robust.RobustEstimatorMethod getMethod()
      Returns method being used for robust estimation.
      Returns:
      method being used for robust estimation.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(boolean commonAxisUsed, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, boolean commonAxisUsed, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, boolean commonAxisUsed, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - kknown hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.*
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, boolean commonAxisUsed, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener, com.irurueta.numerical.robust.RobustEstimatorMethod method)
      Creates a robust magnetometer calibrator.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      method - robust estimator method.
      Returns:
      a robust magnetometer 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, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create()
      Creates a robust magnetometer calibrator with default robust method.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(boolean commonAxisUsed)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron to find a solution.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, boolean commonAxisUsed)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer 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.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, boolean commonAxisUsed)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      commonAxisUsed - indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.*
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, boolean commonAxisUsed)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm expressed in Teslas (T).
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer 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 or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer calibrator.
      Throws:
      IllegalArgumentException - if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer 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, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer 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, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      Returns:
      a robust magnetometer 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, or if provided quality scores length is smaller than 10 samples.

    • create

      public static RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator create(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix hardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibratorListener listener)
      Creates a robust magnetometer calibrator with default robust method.
      Parameters:
      qualityScores - quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.
      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.
      hardIron - known hard-iron.
      initialMm - initial soft-iron matrix containing scale factors and cross coupling errors.
      listener - listener to handle events raised by this calibrator.
      Returns:
      a robust magnetometer 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, or if provided quality scores length is smaller than 10 samples.

    • computeError

      protected double computeError(StandardDeviationBodyMagneticFluxDensity measurement, RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator.PreliminaryResult preliminaryResult)
      Computes error of a preliminary result respect a given measurement.
      Parameters:
      measurement - a measurement.
      preliminaryResult - a preliminary result.
      Returns:
      computed error.

    • computePreliminarySolutions

      protected void computePreliminarySolutions(int[] samplesIndices, List<RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator.PreliminaryResult> solutions)
      Computes a preliminary solution for a subset of samples picked by a robust estimator.
      Parameters:
      samplesIndices - indices of samples picked by the robust estimator.
      solutions - list where estimated preliminary solution will be stored.

    • attemptRefine

      protected void attemptRefine(RobustKnownHardIronMagneticFluxDensityNormMagnetometerCalibrator.PreliminaryResult preliminaryResult)
      Attempts to refine calibration parameters if refinement is requested. This method returns a refined solution or provided input if refinement is not requested or has failed. If refinement is enabled and it is requested to keep covariance, this method will also keep covariance of refined position.
      Parameters:
      preliminaryResult - a preliminary result.

    • internalSetGroundTruthMagneticFluxDensityNorm

      private void internalSetGroundTruthMagneticFluxDensityNorm(Double groundTruthMagneticFluxDensityNorm)
      Internally sets ground truth magnetic flux density norm to be expected at location where measurements have been made, expressed in Teslas (T).
      Parameters:
      groundTruthMagneticFluxDensityNorm - ground truth magnetic flux density norm or null if undefined.
      Throws:
      IllegalArgumentException - if provided value is negative.

    • convertMagneticFluxDensity

      private static double convertMagneticFluxDensity(double value, com.irurueta.units.MagneticFluxDensityUnit unit)
      Converts magnetic flux density value and unit to Teslas.
      Parameters:
      value - magnetic flux density value.
      unit - unit of magnetic flux density value.
      Returns:
      converted value.

    • convertMagneticFluxDensity

      private static double convertMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity magneticFluxDensity)
      Converts magnetic flux density instance to Teslas.
      Parameters:
      magneticFluxDensity - magnetic flux density instance to be converted.
      Returns:
      converted value.