Class PROSACRobustKnownFrameMagnetometerCalibrator
java.lang.Object
com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownFrameMagnetometerCalibrator
com.irurueta.navigation.inertial.calibration.magnetometer.PROSACRobustKnownFrameMagnetometerCalibrator
- All Implemented Interfaces:
MagnetometerCalibrator
,MagnetometerNonLinearCalibrator
,OrderedStandardDeviationFrameBodyMagneticFluxDensityMagnetometerCalibrator
,QualityScoredMagnetometerCalibrator
,UnknownHardIronMagnetometerCalibrator
,UnknownHardIronNonLinearMagnetometerCalibrator
public class PROSACRobustKnownFrameMagnetometerCalibrator
extends RobustKnownFrameMagnetometerCalibrator
Robustly estimates magnetometer hard-iron biases, soft-iron cross
couplings and scaling factors using PROSAC algorithm.
To use this calibrator at least 4 measurements at different known frames must be provided. In other words, magnetometer samples must be obtained at 4 different positions or orientations. Notice that frame velocities are ignored by this calibrator.
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownFrameMagnetometerCalibrator
RobustKnownFrameMagnetometerCalibrator.PreliminaryResult
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Indicates whether inliers must be computed and kept.private boolean
Indicates whether residuals must be computed and kept.static final boolean
Indicates that by default inliers will only be computed but not kept.static final boolean
Indicates that by default residuals will only be computed but not kept.static final double
Constant defining default threshold to determine whether samples are inliers or not.static final double
Minimum value that can be set as threshold.private double[]
Quality scores corresponding to each provided sample.private double
Threshold to determine whether samples are inliers or not when testing possible solutions.Fields inherited from class com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownFrameMagnetometerCalibrator
confidence, DEFAULT_CONFIDENCE, DEFAULT_KEEP_COVARIANCE, DEFAULT_MAX_ITERATIONS, DEFAULT_PROGRESS_DELTA, DEFAULT_REFINE_PRELIMINARY_SOLUTIONS, DEFAULT_REFINE_RESULT, DEFAULT_ROBUST_METHOD, DEFAULT_USE_COMMON_Z_AXIS, DEFAULT_USE_LINEAR_CALIBRATOR, inliersData, listener, MAX_CONFIDENCE, MAX_PROGRESS_DELTA, maxIterations, measurements, MIN_CONFIDENCE, MIN_ITERATIONS, MIN_PROGRESS_DELTA, MINIMUM_MEASUREMENTS, preliminarySubsetSize, progressDelta, refineResult, running
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor.PROSACRobustKnownFrameMagnetometerCalibrator
(boolean commonAxisUsed) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(boolean commonAxisUsed, RobustKnownFrameMagnetometerCalibratorListener listener) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(double[] qualityScores) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(double[] qualityScores, boolean commonAxisUsed) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(double[] qualityScores, boolean commonAxisUsed, RobustKnownFrameMagnetometerCalibratorListener listener) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(double[] qualityScores, RobustKnownFrameMagnetometerCalibratorListener listener) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationFrameBodyMagneticFluxDensity> measurements) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationFrameBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationFrameBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownFrameMagnetometerCalibratorListener listener) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(double[] qualityScores, List<StandardDeviationFrameBodyMagneticFluxDensity> measurements, RobustKnownFrameMagnetometerCalibratorListener listener) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(RobustKnownFrameMagnetometerCalibratorListener listener) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(List<StandardDeviationFrameBodyMagneticFluxDensity> measurements) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(List<StandardDeviationFrameBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(List<StandardDeviationFrameBodyMagneticFluxDensity> measurements, boolean commonAxisUsed, RobustKnownFrameMagnetometerCalibratorListener listener) Constructor.PROSACRobustKnownFrameMagnetometerCalibrator
(List<StandardDeviationFrameBodyMagneticFluxDensity> measurements, RobustKnownFrameMagnetometerCalibratorListener 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
Gets threshold to determine whether samples are inliers or not when testing possible solutions.private void
internalSetQualityScores
(double[] qualityScores) Sets quality scores corresponding to each provided sample.boolean
Indicates whether inliers must be computed and kept.boolean
Indicates whether residuals must be computed and kept.boolean
Indicates whether this calibrator requires quality scores for each measurement or not.boolean
isReady()
Indicates whether calibrator is ready to find a solution.void
setComputeAndKeepInliersEnabled
(boolean computeAndKeepInliers) Specifies whether inliers must be computed and kept.void
setComputeAndKeepResidualsEnabled
(boolean computeAndKeepResiduals) Specifies whether residuals must be computed and kept.void
setQualityScores
(double[] qualityScores) Sets quality scores corresponding to each provided sample.void
setThreshold
(double threshold) Sets threshold to determine whether samples are inliers or not when testing possible solutions.Methods inherited from class com.irurueta.navigation.inertial.calibration.magnetometer.RobustKnownFrameMagnetometerCalibrator
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, 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, 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, getMagneticModel, getMaxIterations, getMeasurements, getMeasurementType, getMinimumRequiredMeasurements, getPreliminarySubsetSize, getProgressDelta, isCommonAxisUsed, isCovarianceKept, isLinearCalibratorUsed, isOrderedMeasurementsRequired, isPreliminarySolutionRefined, isResultRefined, isRunning, setCommonAxisUsed, setConfidence, setCovarianceKept, setInitialCrossCouplingErrors, setInitialHardIron, setInitialHardIron, setInitialHardIron, setInitialHardIron, setInitialHardIron, setInitialHardIronX, setInitialHardIronX, setInitialHardIronY, setInitialHardIronY, setInitialHardIronZ, setInitialHardIronZ, setInitialMm, setInitialMxy, setInitialMxz, setInitialMyx, setInitialMyz, setInitialMzx, setInitialMzy, setInitialScalingFactors, setInitialScalingFactorsAndCrossCouplingErrors, setInitialSx, setInitialSy, setInitialSz, setLinearCalibratorUsed, setListener, setMagneticModel, setMaxIterations, setMeasurements, setPreliminarySolutionRefined, setPreliminarySubsetSize, setProgressDelta, setResultRefined, setupWmmEstimator
-
Field Details
-
DEFAULT_THRESHOLD
public static final double DEFAULT_THRESHOLDConstant defining default threshold to determine whether samples are inliers or not.- See Also:
-
MIN_THRESHOLD
public static final double MIN_THRESHOLDMinimum value that can be set as threshold. Threshold must be strictly greater than 0.0.- See Also:
-
DEFAULT_COMPUTE_AND_KEEP_INLIERS
public static final boolean DEFAULT_COMPUTE_AND_KEEP_INLIERSIndicates that by default inliers will only be computed but not kept.- See Also:
-
DEFAULT_COMPUTE_AND_KEEP_RESIDUALS
public static final boolean DEFAULT_COMPUTE_AND_KEEP_RESIDUALSIndicates that by default residuals will only be computed but not kept.- See Also:
-
threshold
private double thresholdThreshold to determine whether samples are inliers or not when testing possible solutions. The threshold refers to the amount of error on distance between estimated position and distances provided for each sample. -
computeAndKeepInliers
private boolean computeAndKeepInliersIndicates whether inliers must be computed and kept. -
computeAndKeepResiduals
private boolean computeAndKeepResidualsIndicates whether residuals must be computed and kept. -
qualityScores
private double[] qualityScoresQuality scores corresponding to each provided sample. The larger the score value the better the quality of the sample.
-
-
Constructor Details
-
PROSACRobustKnownFrameMagnetometerCalibrator
public PROSACRobustKnownFrameMagnetometerCalibrator()Constructor. -
PROSACRobustKnownFrameMagnetometerCalibrator
public PROSACRobustKnownFrameMagnetometerCalibrator(List<StandardDeviationFrameBodyMagneticFluxDensity> measurements) Constructor.- Parameters:
measurements
- list of body magnetic flux density measurements with standard deviations taken at different frames (positions and orientations).
-
PROSACRobustKnownFrameMagnetometerCalibrator
public PROSACRobustKnownFrameMagnetometerCalibrator(boolean commonAxisUsed) Constructor.- Parameters:
commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
-
PROSACRobustKnownFrameMagnetometerCalibrator
public PROSACRobustKnownFrameMagnetometerCalibrator(List<StandardDeviationFrameBodyMagneticFluxDensity> measurements, boolean commonAxisUsed) Constructor.- Parameters:
measurements
- list of body magnetic flux density measurements with standard deviations taken at different frames (positions and orientations).commonAxisUsed
- indicates whether z-axis is assumed to be common for the accelerometer, gyroscope and magnetometer.
-
PROSACRobustKnownFrameMagnetometerCalibrator
public PROSACRobustKnownFrameMagnetometerCalibrator(double[] qualityScores) Constructor.- Parameters:
qualityScores
- quality scores corresponding to each provided measurement. The larger the score value the better the quality of the sample.- Throws:
IllegalArgumentException
- if provided quality scores length is smaller than 4 samples.
-
PROSACRobustKnownFrameMagnetometerCalibrator
public PROSACRobustKnownFrameMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationFrameBodyMagneticFluxDensity> 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 deviations taken at different frames (positions and orientations).- Throws:
IllegalArgumentException
- if provided quality scores length is smaller than 4 samples.
-
PROSACRobustKnownFrameMagnetometerCalibrator
public PROSACRobustKnownFrameMagnetometerCalibrator(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 4 samples.
-
PROSACRobustKnownFrameMagnetometerCalibrator
public PROSACRobustKnownFrameMagnetometerCalibrator(double[] qualityScores, List<StandardDeviationFrameBodyMagneticFluxDensity> 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
- list of body magnetic flux density measurements with standard deviations taken at different frames (positions and 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 4 samples.
-
-
Method Details
-
getThreshold
public double getThreshold()Gets threshold to determine whether samples are inliers or not when testing possible solutions. The threshold refers to the amount of error on norm between measured specific forces and the ones generated with estimated calibration parameters provided for each sample.- Returns:
- threshold to determine whether samples are inliers or not.
-
setThreshold
public void setThreshold(double threshold) throws com.irurueta.navigation.LockedException Sets threshold to determine whether samples are inliers or not when testing possible solutions. The threshold refers to the amount of error on norm between measured specific forces and the ones generated with estimated calibration parameters provided for each sample.- Parameters:
threshold
- threshold to determine whether samples are inliers or not.- Throws:
IllegalArgumentException
- if provided value is equal or less than zero.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 classRobustKnownFrameMagnetometerCalibrator
- 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 classRobustKnownFrameMagnetometerCalibrator
- 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 calibrator is ready to find a solution.- Specified by:
isReady
in interfaceMagnetometerCalibrator
- Overrides:
isReady
in classRobustKnownFrameMagnetometerCalibrator
- Returns:
- true if calibrator is ready, false otherwise.
-
isComputeAndKeepInliersEnabled
public boolean isComputeAndKeepInliersEnabled()Indicates whether inliers must be computed and kept.- Returns:
- true if inliers must be computed and kept, false if inliers only need to be computed but not kept.
-
setComputeAndKeepInliersEnabled
public void setComputeAndKeepInliersEnabled(boolean computeAndKeepInliers) throws com.irurueta.navigation.LockedException Specifies whether inliers must be computed and kept.- Parameters:
computeAndKeepInliers
- true if inliers must be computed and kept, false if inliers only need to be computed but not kept.- Throws:
com.irurueta.navigation.LockedException
- if calibrator is currently running.
-
isComputeAndKeepResiduals
public boolean isComputeAndKeepResiduals()Indicates whether residuals must be computed and kept.- Returns:
- true if residuals must be computed and kept, false if residuals only need to be computed but not kept.
-
setComputeAndKeepResidualsEnabled
public void setComputeAndKeepResidualsEnabled(boolean computeAndKeepResiduals) throws com.irurueta.navigation.LockedException Specifies whether residuals must be computed and kept.- Parameters:
computeAndKeepResiduals
- true if residuals must be computed and kept, false if residuals only need to be computed but not kept.- Throws:
com.irurueta.navigation.LockedException
- if calibrator is currently running.
-
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 classRobustKnownFrameMagnetometerCalibrator
- 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.
-