Package com.irurueta.navigation.inertial.calibration.magnetometer

Interface UnknownHardIronMagnetometerCalibrator

All Known Subinterfaces:
KnownFrameMagnetometerCalibrator<T,L>, UnknownHardIronNonLinearMagnetometerCalibrator
All Known Implementing Classes:
BaseMagneticFluxDensityNormMagnetometerCalibrator, KnownFrameMagnetometerLinearLeastSquaresCalibrator, KnownFrameMagnetometerNonLinearLeastSquaresCalibrator, KnownMagneticFluxDensityNormMagnetometerCalibrator, KnownPositionAndInstantMagnetometerCalibrator, LMedSRobustKnownFrameMagnetometerCalibrator, LMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, LMedSRobustKnownPositionAndInstantMagnetometerCalibrator, MSACRobustKnownFrameMagnetometerCalibrator, MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, MSACRobustKnownPositionAndInstantMagnetometerCalibrator, PROMedSRobustKnownFrameMagnetometerCalibrator, PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, PROMedSRobustKnownPositionAndInstantMagnetometerCalibrator, PROSACRobustKnownFrameMagnetometerCalibrator, PROSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, PROSACRobustKnownPositionAndInstantMagnetometerCalibrator, RANSACRobustKnownFrameMagnetometerCalibrator, RANSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, RANSACRobustKnownPositionAndInstantMagnetometerCalibrator, RobustKnownFrameMagnetometerCalibrator, RobustKnownMagneticFluxDensityNormMagnetometerCalibrator, RobustKnownPositionAndInstantMagnetometerCalibrator
public interface UnknownHardIronMagnetometerCalibrator
Interface for magnetometer calibrator where bias is unknown and needs to be estimated.

  • Method Details

    • getEstimatedHardIron

      double[] getEstimatedHardIron()
      Gets array containing x,y,z components of estimated magnetometer hard-iron biases expressed in Teslas (T).
      Returns:
      array containing x,y,z components of estimated magnetometer hard-iron biases.

    • getEstimatedHardIron

      boolean getEstimatedHardIron(double[] result)
      Gets array containing x,y,z components of estimated magnetometer hard-iron biases expressed in Teslas (T).
      Parameters:
      result - instance where estimated magnetometer biases will be stored.
      Returns:
      true if result instance was updated, false otherwise (when estimation is not yet available).

    • getEstimatedHardIronAsMatrix

      com.irurueta.algebra.Matrix getEstimatedHardIronAsMatrix()
      Gets column matrix containing x,y,z components of estimated magnetometer hard-iron biases expressed in Teslas (T).
      Returns:
      column matrix containing x,y,z components of estimated magnetometer hard-iron biases.

    • getEstimatedHardIronAsMatrix

      boolean getEstimatedHardIronAsMatrix(com.irurueta.algebra.Matrix result) throws com.irurueta.algebra.WrongSizeException
      Gets column matrix containing x,y,z components of estimated magnetometer hard-iron biases expressed in Teslas (T).
      Parameters:
      result - instance where result data will be stored.
      Returns:
      true if result was updated, false otherwise.
      Throws:
      com.irurueta.algebra.WrongSizeException - if provided result instance has invalid size.

    • getEstimatedHardIronX

      Double getEstimatedHardIronX()
      Gets x coordinate of estimated magnetometer bias expressed in Teslas (T).
      Returns:
      x coordinate of estimated magnetometer bias or null if not available.

    • getEstimatedHardIronY

      Double getEstimatedHardIronY()
      Gets y coordinate of estimated magnetometer bias expressed in Teslas (T).
      Returns:
      y coordinate of estimated magnetometer bias or null if not available.

    • getEstimatedHardIronZ

      Double getEstimatedHardIronZ()
      Gets z coordinate of estimated magnetometer bias expressed in Teslas (T).
      Returns:
      z coordinate of estimated magnetometer bias or null if not available.

    • getEstimatedHardIronXAsMagneticFluxDensity

      com.irurueta.units.MagneticFluxDensity getEstimatedHardIronXAsMagneticFluxDensity()
      Gets x coordinate of estimated magnetometer bias.
      Returns:
      x coordinate of estimated magnetometer bias.

    • getEstimatedHardIronXAsMagneticFluxDensity

      boolean getEstimatedHardIronXAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets x coordinate of estimated magnetometer bias.
      Parameters:
      result - instance where result will be stored.
      Returns:
      true if estimated magnetometer bias is available, false otherwise.

    • getEstimatedHardIronYAsMagneticFluxDensity

      com.irurueta.units.MagneticFluxDensity getEstimatedHardIronYAsMagneticFluxDensity()
      Gets y coordinate of estimated magnetometer bias.
      Returns:
      y coordinate of estimated magnetometer bias.

    • getEstimatedHardIronYAsMagneticFluxDensity

      boolean getEstimatedHardIronYAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets y coordinate of estimated magnetometer bias.
      Parameters:
      result - instance where result will be stored.
      Returns:
      true if estimated magnetometer bias is available, false otherwise.

    • getEstimatedHardIronZAsMagneticFluxDensity

      com.irurueta.units.MagneticFluxDensity getEstimatedHardIronZAsMagneticFluxDensity()
      Gets z coordinate of estimated magnetometer bias.
      Returns:
      z coordinate of estimated magnetometer bias.

    • getEstimatedHardIronZAsMagneticFluxDensity

      boolean getEstimatedHardIronZAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets z coordinate of estimated magnetometer bias.
      Parameters:
      result - instance where result will be stored.
      Returns:
      true if estimated magnetometer bias is available, false otherwise.

    • getEstimatedHardIronAsTriad

      MagneticFluxDensityTriad getEstimatedHardIronAsTriad()
      Gets estimated magnetometer bias.
      Returns:
      estimated magnetometer bias or null if not available.

    • getEstimatedHardIronAsTriad

      boolean getEstimatedHardIronAsTriad(MagneticFluxDensityTriad result)
      Gets estimated magnetometer bias.
      Parameters:
      result - instance where result will be stored.
      Returns:
      true if estimated magnetometer bias is available and result was modified, false otherwise.