getMagnetometerInitialHardIronYAsMeasurement

fun getMagnetometerInitialHardIronYAsMeasurement(result: MagneticFluxDensity): Boolean

Gets Y-coordinate of hard iron used as an initial guess. This value is determined once the calibration starts. If magnetometerSensorType is MagnetometerSensorType.MAGNETOMETER_UNCALIBRATED, this will be equal to the value used internally by the device as part of the magnetometer hardware calibration. If magnetometerSensorType 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 isMagnetometerGroundTruthInitialHardIron is true, this is assumed to be the true hard iron, and estimatedMagnetometerHardIronY will be equal to this value, otherwise estimatedMagnetometerHardIronY will be the estimated hard iron after solving calibration, which will differ from magnetometerInitialHardIronY.

Return

true if initial hard iron is available, false otherwise.

Parameters

result

instance where result will be stored.