MagnetometerInternalCalibratorBuilder

constructor(measurements: List<StandardDeviationBodyMagneticFluxDensity>, robustPreliminarySubsetSize: Int, minimumRequiredMeasurements: Int, groundTruthMagneticFluxDensityNorm: Double? = null, location: Location? = null, timestamp: Date? = Date(), robustMethod: RobustEstimatorMethod? = null, robustConfidence: Double = StaticIntervalMagnetometerCalibrator.ROBUST_DEFAULT_CONFIDENCE, robustMaxIterations: Int = StaticIntervalMagnetometerCalibrator.ROBUST_DEFAULT_MAX_ITERATIONS, robustThreshold: Double? = null, robustThresholdFactor: Double = StaticIntervalMagnetometerCalibrator.DEFAULT_ROBUST_THRESHOLD_FACTOR, robustStopThresholdFactor: Double = StaticIntervalMagnetometerCalibrator.DEFAULT_ROBUST_STOP_THRESHOLD_FACTOR, isGroundTruthInitialHardIron: Boolean = false, isCommonAxisUsed: Boolean = false, initialHardIronX: Double? = null, initialHardIronY: Double? = null, initialHardIronZ: Double? = null, initialSx: Double = 0.0, initialSy: Double = 0.0, initialSz: Double = 0.0, initialMxy: Double = 0.0, initialMxz: Double = 0.0, initialMyx: Double = 0.0, initialMyz: Double = 0.0, initialMzx: Double = 0.0, initialMzy: Double = 0.0, baseNoiseLevel: Double? = null, worldMagneticModel: WorldMagneticModel? = null, qualityScoreMapper: QualityScoreMapper<StandardDeviationBodyMagneticFluxDensity> = DefaultMagnetometerQualityScoreMapper())

Constructor.

Parameters

measurements

List of magnetometer measurements.

groundTruthMagneticFluxDensityNorm

Norm of ground truth magnetic flux density norm to be expected at location where measurements have been made, expressed in Teslas (T).

robustPreliminarySubsetSize

Size of preliminary subsets picked while finding a robust magnetometer calibration solution.

minimumRequiredMeasurements

Minimum number of required measurements to start magnetometer calibration.

robustMethod

Indicates robust method used to solve magnetometer calibration.

robustConfidence

Confidence of estimated accelerometer calibration result expressed as a value between 0.0 and 1.0.

robustMaxIterations

Maximum number of iterations to attempt to find a robust accelerometer calibration solution. By default this is 5000.

robustThreshold

Threshold to be used to determine whether a measurement is considered an outlier by robust accelerometer calibration algorithms or not.

robustThresholdFactor

Factor to be used respect estimated accelerometer base noise level to consider a measurement an outlier when using robust calibration methods.

robustStopThresholdFactor

Additional factor to be taken into account for robust methods based on LMedS or PROMedS, where factor is not directly related to LMSE, but to a smaller value.

isGroundTruthInitialHardIron

Indicates whether magnetometer initial hard iron is considered a ground-truth known hard iron.

isCommonAxisUsed

Indicates or specifies whether z-axis is assumed to be common for magnetometer, gyroscope and accelerometer.

initialHardIronX

x-coordinate of magnetometer hard iron used as an initial guess and expressed in Teslas (T).

initialHardIronY

y-coordinate of magnetometer hard iron used as an initial guess and expressed in Teslas (T).

initialHardIronZ

z-coordinate of magnetometer hard iron used as an initial guess and expressed in Teslas (T).

initialSx

initial x scaling factor for magnetometer calibration.

initialSy

initial y scaling factor for magnetometer calibration.

initialSz

initial z scaling factor for magnetometer calibration.

initialMxy

initial x-y cross coupling error for magnetometer calibration.

initialMxz

initial x-z cross coupling error for magnetometer calibration.

initialMyx

initial y-x cross coupling error for magnetometer calibration.

initialMyz

initial y-z cross coupling error for magnetometer calibration.

initialMzx

initial z-x cross coupling error for magnetometer calibration.

initialMzy

initial z-y cross coupling error for magnetometer calibration.

baseNoiseLevel

magnetometer measurement base noise level that has been detected during initialization expressed in Teslas (T).

qualityScoreMapper

mapper to convert collected magnetometer measurements into quality scores, based on the amount of standard deviation (the larger the variability, the worse the score will be).