getInitialHardIronXAsMeasurement

fun getInitialHardIronXAsMeasurement(result: MagneticFluxDensity): Boolean

Gets X-coordinate of hard iron used as an initial guess. This value is determined once the calibration starts. If sensorType is MagnetometerSensorType.MAGNETOMETER_UNCALIBRATED, this will be equal to the value used internally by the device as part of the magnetometer hardware calibration. If sensorType is MagnetometerSensorType.MAGNETOMETER, then magnetometer sensor measurements are assumed to be already hard iron compensated, and the initial hard iron is assumed to be zero. If isGroundTruthInitialHardIron is true, this is assumed to be the true hard iron, and estimatedHardIronX will be equal to this value, otherwise estimatedHardIronX will be the estimated hard iron after solving calibration, which will differ from initialHardIronX.

Return

true if initial hard iron is available, false otherwise.

Parameters

result

instance where result will be stored.