Class PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
java.lang.Object
com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownMagneticFluxDensityNormMagnetometerCalibrator
com.irurueta.navigation.inertial.calibration.magnetometer.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
- All Implemented Interfaces:
MagnetometerCalibrator
,MagnetometerNonLinearCalibrator
,OrderedStandardDeviationBodyMagneticFluxDensityMagnetometerCalibrator
,QualityScoredMagnetometerCalibrator
,UnknownHardIronMagnetometerCalibrator
,UnknownHardIronNonLinearMagnetometerCalibrator
public class PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
extends RobustKnownMagneticFluxDensityNormMagnetometerCalibrator
Robustly estimates magnetometer hard-iron biases, cross couplings and
scaling factors using PROMedS algorithm.
To use this calibrator at least 10 measurements with known magnetic field norm at an unknown position and instant must be taken at 10 different unknown orientations when common z-axis is assumed, otherwise at least 13 measurements are required.
Measured magnetic flux density is assumed to follow the model shown below:
mBmeas = bm + (I + Mm) * mBtrue + wWhere: - 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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownMagneticFluxDensityNormMagnetometerCalibrator
RobustKnownMagneticFluxDensityNormMagnetometerCalibrator.PreliminaryResult
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final double
Default value to be used for stop threshold.static final double
Minimum allowed stop threshold value.private double[]
Quality scores corresponding to each provided sample.private double
Threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough.Fields inherited from class com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownMagneticFluxDensityNormMagnetometerCalibrator
confidence, DEFAULT_CONFIDENCE, DEFAULT_KEEP_COVARIANCE, DEFAULT_MAX_ITERATIONS, DEFAULT_PROGRESS_DELTA, DEFAULT_REFINE_RESULT, DEFAULT_ROBUST_METHOD, DEFAULT_USE_COMMON_Z_AXIS, groundTruthMagneticFluxDensityNorm, identity, inliersData, listener, MAX_CONFIDENCE, MAX_PROGRESS_DELTA, maxIterations, measurements, MIN_CONFIDENCE, MIN_ITERATIONS, MIN_PROGRESS_DELTA, MINIMUM_MEASUREMENTS_COMMON_Z_AXIS, MINIMUM_MEASUREMENTS_GENERAL, preliminarySubsetSize, progressDelta, refineResult, running, tmp1, tmp2, tmp3, tmp4
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(boolean commonAxisUsed) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, boolean commonAxisUsed) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, boolean commonAxisUsed) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, boolean commonAxisUsed) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor.PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
(List<StandardDeviationBodyMagneticFluxDensity> measurements, RobustKnownMagneticFluxDensityNormMagnetometerCalibratorListener listener) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Estimates magnetometer calibration parameters containing hard-iron bias and soft-iron scale factors and cross-coupling errors.com.irurueta.numerical.robust.RobustEstimatorMethod
Returns method being used for robust estimation.double[]
Returns quality scores corresponding to each provided sample.double
Returns threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough.private void
internalSetQualityScores
(double[] qualityScores) Sets quality scores corresponding to each provided sample.boolean
Indicates whether this calibrator requires quality scores for each measurement or not.boolean
isReady()
Indicates whether solver is ready to find a solution.void
setQualityScores
(double[] qualityScores) Sets quality scores corresponding to each provided sample.void
setStopThreshold
(double stopThreshold) Sets threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough.Methods inherited from class com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownMagneticFluxDensityNormMagnetometerCalibrator
attemptRefine, computeError, computePreliminarySolutions, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, getConfidence, getEstimatedChiSq, getEstimatedCovariance, getEstimatedHardIron, getEstimatedHardIron, getEstimatedHardIronAsMatrix, getEstimatedHardIronAsMatrix, getEstimatedHardIronAsTriad, getEstimatedHardIronAsTriad, getEstimatedHardIronStandardDeviation, getEstimatedHardIronStandardDeviation, getEstimatedHardIronStandardDeviationAverage, getEstimatedHardIronStandardDeviationAverageAsMagneticFluxDensity, getEstimatedHardIronStandardDeviationAverageAsMagneticFluxDensity, getEstimatedHardIronStandardDeviationNorm, getEstimatedHardIronStandardDeviationNormAsMagneticFluxDensity, getEstimatedHardIronStandardDeviationNormAsMagneticFluxDensity, getEstimatedHardIronX, getEstimatedHardIronXAsMagneticFluxDensity, getEstimatedHardIronXAsMagneticFluxDensity, getEstimatedHardIronXStandardDeviation, getEstimatedHardIronXStandardDeviationAsMagneticFluxDensity, getEstimatedHardIronXStandardDeviationAsMagneticFluxDensity, getEstimatedHardIronXVariance, getEstimatedHardIronY, getEstimatedHardIronYAsMagneticFluxDensity, getEstimatedHardIronYAsMagneticFluxDensity, getEstimatedHardIronYStandardDeviation, getEstimatedHardIronYStandardDeviationAsMagneticFluxDensity, getEstimatedHardIronYStandardDeviationAsMagneticFluxDensity, getEstimatedHardIronYVariance, getEstimatedHardIronZ, getEstimatedHardIronZAsMagneticFluxDensity, getEstimatedHardIronZAsMagneticFluxDensity, getEstimatedHardIronZStandardDeviation, getEstimatedHardIronZStandardDeviationAsMagneticFluxDensity, getEstimatedHardIronZStandardDeviationAsMagneticFluxDensity, getEstimatedHardIronZVariance, getEstimatedMm, getEstimatedMse, getEstimatedMxy, getEstimatedMxz, getEstimatedMyx, getEstimatedMyz, getEstimatedMzx, getEstimatedMzy, getEstimatedSx, getEstimatedSy, getEstimatedSz, getGroundTruthMagneticFluxDensityNorm, getGroundTruthMagneticFluxDensityNormAsMagneticFluxDensity, getGroundTruthMagneticFluxDensityNormAsMagneticFluxDensity, getInitialHardIron, getInitialHardIron, getInitialHardIronAsMatrix, getInitialHardIronAsMatrix, getInitialHardIronAsTriad, getInitialHardIronAsTriad, getInitialHardIronX, getInitialHardIronXAsMagneticFluxDensity, getInitialHardIronXAsMagneticFluxDensity, getInitialHardIronY, getInitialHardIronYAsMagneticFluxDensity, getInitialHardIronYAsMagneticFluxDensity, getInitialHardIronZ, getInitialHardIronZAsMagneticFluxDensity, getInitialHardIronZAsMagneticFluxDensity, getInitialMm, getInitialMm, getInitialMxy, getInitialMxz, getInitialMyx, getInitialMyz, getInitialMzx, getInitialMzy, getInitialSx, getInitialSy, getInitialSz, getInliersData, getListener, getMaxIterations, getMeasurements, getMeasurementType, getMinimumRequiredMeasurements, getPreliminarySubsetSize, getProgressDelta, isCommonAxisUsed, isCovarianceKept, isOrderedMeasurementsRequired, isResultRefined, isRunning, setCommonAxisUsed, setConfidence, setCovarianceKept, setGroundTruthMagneticFluxDensityNorm, setGroundTruthMagneticFluxDensityNorm, setInitialCrossCouplingErrors, setInitialHardIron, setInitialHardIron, setInitialHardIron, setInitialHardIron, setInitialHardIron, setInitialHardIronX, setInitialHardIronX, setInitialHardIronY, setInitialHardIronY, setInitialHardIronZ, setInitialHardIronZ, setInitialMm, setInitialMxy, setInitialMxz, setInitialMyx, setInitialMyz, setInitialMzx, setInitialMzy, setInitialScalingFactors, setInitialScalingFactorsAndCrossCouplingErrors, setInitialSx, setInitialSy, setInitialSz, setListener, setMaxIterations, setMeasurements, setPreliminarySubsetSize, setProgressDelta, setResultRefined
-
Field Details
-
DEFAULT_STOP_THRESHOLD
public static final double DEFAULT_STOP_THRESHOLDDefault value to be used for stop threshold. Stop threshold can be used to avoid keeping the algorithm unnecessarily iterating in case that best estimated threshold using median of residuals is not small enough. Once a solution is found that generates a threshold below this value, the algorithm will stop. The stop threshold can be used to prevent the LMedS algorithm iterating too many times in cases where samples have a very similar accuracy. For instance, in cases where proportion of outliers is very small (close to 0%), and samples are very accurate (i.e. 1e-6), the algorithm would iterate for a long time trying to find the best solution when indeed there is no need to do that if a reasonable threshold has already been reached. Because of this behaviour the stop threshold can be set to a value much lower than the one typically used in RANSAC, and yet the algorithm could still produce even smaller thresholds in estimated results.- See Also:
-
MIN_STOP_THRESHOLD
public static final double MIN_STOP_THRESHOLDMinimum allowed stop threshold value.- See Also:
-
stopThreshold
private double stopThresholdThreshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough. Once a solution is found that generates a threshold below this value, the algorithm will stop. The stop threshold can be used to prevent the LMedS algorithm iterating too many times in cases where samples have a very similar accuracy. For instance, in cases where proportion of outliers is very small (close to 0%), and samples are very accurate (i.e. 1e-6), the algorithm would iterate for a long time trying to find the best solution when indeed there is no need to do that if a reasonable threshold has already been reached. Because of this behaviour the stop threshold can be set to a value much lower than the one typically used in RANSAC, and yet the algorithm could still produce even smaller thresholds in estimated results. -
qualityScores
private double[] qualityScoresQuality scores corresponding to each provided sample. The larger the score value the better the quality of the sample.
-
-
Constructor Details
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator()Constructor. -
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(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.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(boolean commonAxisUsed) Constructor.- Parameters:
commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] initialHardIron) Constructor.- Parameters:
initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron array does not have length 3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(com.irurueta.algebra.Matrix initialHardIron) Constructor.- Parameters:
initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- Parameters:
initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(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.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron) Constructor.- Parameters:
measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron array does not have length 3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron) Constructor.- Parameters:
measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron array does not have length 3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron) Constructor.- Parameters:
measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron) Constructor.- Parameters:
measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- Parameters:
measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- Parameters:
measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(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.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(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.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(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.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, double[] initialHardIron) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(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.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- Parameters:
groundTruthMagneticFluxDensityNorm
- ground truth magnetic flux density norm expressed in Teslas (T).measurements
- collection of body magnetic flux density measurements with standard deviation of magnetometer measurements taken at the same position with zero velocity and unknown different orientations.commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements) Constructor.- 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.- Throws:
IllegalArgumentException
- if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, boolean commonAxisUsed) Constructor.- 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.- Throws:
IllegalArgumentException
- if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, double[] initialHardIron) Constructor.- Parameters:
qualityScores
- quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, com.irurueta.algebra.Matrix initialHardIron) Constructor.- Parameters:
qualityScores
- quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- Parameters:
qualityScores
- quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.- 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.- Throws:
IllegalArgumentException
- if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron array does not have length 3 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm) Constructor.- 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).- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements) Constructor.- 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.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, boolean commonAxisUsed) Constructor.- 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.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, double[] initialHardIron) Constructor.- 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).initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron) Constructor.- 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).initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- 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).initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3 or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.- 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.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, double[] initialHardIron) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, double[] initialHardIron) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron array does not have length 3, or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1, or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3, or if provided quality scores length is smaller than 10 samples.
-
PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
public PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator(double[] qualityScores, Double groundTruthMagneticFluxDensityNorm, List<StandardDeviationBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, com.irurueta.algebra.Matrix initialHardIron, com.irurueta.algebra.Matrix initialMm) Constructor.- 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.initialHardIron
- initial hard-iron to find a solution.initialMm
- initial soft-iron matrix containing scale factors and cross coupling errors.- Throws:
IllegalArgumentException
- if provided magnetic flux norm value is negative, or if provided hard-iron matrix is not 3x1 or if soft-iron matrix is not 3x3, or if provided quality scores length is smaller than 10 samples.
-
-
Method Details
-
getStopThreshold
public double getStopThreshold()Returns threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough. Once a solution is found that generates a threshold below this value, the algorithm will stop. The stop threshold can be used to prevent the LMedS algorithm to iterate too many times in cases where samples have a very similar accuracy. For instance, in cases where proportion of outliers is very small (close to 0%), and samples are very accurate (i.e. 1e-6), the algorithm would iterate for a long time trying to find the best solution when indeed there is no need to do that if a reasonable threshold has already been reached. Because of this behaviour the stop threshold can be set to a value much lower than the one typically used in RANSAC, and yet the algorithm could still produce even smaller thresholds in estimated results.- Returns:
- stop threshold to stop the algorithm prematurely when a certain accuracy has been reached.
-
setStopThreshold
public void setStopThreshold(double stopThreshold) throws com.irurueta.navigation.LockedException Sets threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough. Once a solution is found that generates a threshold below this value, the algorithm will stop. The stop threshold can be used to prevent the LMedS algorithm to iterate too many times in cases where samples have a very similar accuracy. For instance, in cases where proportion of outliers is very small (close to 0%), and samples are very accurate (i.e. 1e-6), the algorithm would iterate for a long time trying to find the best solution when indeed there is no need to do that if a reasonable threshold has already been reached. Because of this behaviour the stop threshold can be set to a value much lower than the one typically used in RANSAC, and yet the algorithm could still produce even smaller thresholds in estimated results.- Parameters:
stopThreshold
- stop threshold to stop the algorithm prematurely when a certain accuracy has been reached.- Throws:
IllegalArgumentException
- if provided value is zero or negative.com.irurueta.navigation.LockedException
- if calibrator is currently running.
-
getQualityScores
public double[] getQualityScores()Returns quality scores corresponding to each provided sample. The larger the score value the better the quality of the sample.- Specified by:
getQualityScores
in interfaceQualityScoredMagnetometerCalibrator
- Overrides:
getQualityScores
in classRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
- Returns:
- quality scores corresponding to each sample.
-
setQualityScores
public void setQualityScores(double[] qualityScores) throws com.irurueta.navigation.LockedException Sets quality scores corresponding to each provided sample. The larger the score value the better the quality of the sample.- Specified by:
setQualityScores
in interfaceQualityScoredMagnetometerCalibrator
- Overrides:
setQualityScores
in classRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
- Parameters:
qualityScores
- quality scores corresponding to each sample.- Throws:
IllegalArgumentException
- if provided quality scores length is smaller than minimum required samples.com.irurueta.navigation.LockedException
- if calibrator is currently running.
-
isReady
public boolean isReady()Indicates whether solver is ready to find a solution.- Specified by:
isReady
in interfaceMagnetometerCalibrator
- Overrides:
isReady
in classRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
- Returns:
- true if solver is ready, false otherwise.
-
calibrate
public void calibrate() throws com.irurueta.navigation.LockedException, com.irurueta.navigation.NotReadyException, CalibrationExceptionEstimates magnetometer calibration parameters containing hard-iron bias and soft-iron scale factors and cross-coupling errors.- Throws:
com.irurueta.navigation.LockedException
- if calibrator is currently running.com.irurueta.navigation.NotReadyException
- if calibrator is not ready.CalibrationException
- if estimation fails for numerical reasons.
-
getMethod
public com.irurueta.numerical.robust.RobustEstimatorMethod getMethod()Returns method being used for robust estimation.- Specified by:
getMethod
in classRobustKnownMagneticFluxDensityNormMagnetometerCalibrator
- Returns:
- method being used for robust estimation.
-
isQualityScoresRequired
public boolean isQualityScoresRequired()Indicates whether this calibrator requires quality scores for each measurement or not.- Returns:
- true if quality scores are required, false otherwise.
-
internalSetQualityScores
private void internalSetQualityScores(double[] qualityScores) Sets quality scores corresponding to each provided sample. This method is used internally and does not check whether instance is locked or not.- Parameters:
qualityScores
- quality scores to be set.- Throws:
IllegalArgumentException
- if provided quality scores length is smaller than 4 samples.
-