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

Interface UnknownHardIronNonLinearMagnetometerCalibrator

All Superinterfaces:
UnknownHardIronMagnetometerCalibrator
All Known Implementing Classes:
BaseMagneticFluxDensityNormMagnetometerCalibrator, KnownFrameMagnetometerNonLinearLeastSquaresCalibrator, KnownMagneticFluxDensityNormMagnetometerCalibrator, KnownPositionAndInstantMagnetometerCalibrator, LMedSRobustKnownFrameMagnetometerCalibrator, LMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, LMedSRobustKnownPositionAndInstantMagnetometerCalibrator, MSACRobustKnownFrameMagnetometerCalibrator, MSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, MSACRobustKnownPositionAndInstantMagnetometerCalibrator, PROMedSRobustKnownFrameMagnetometerCalibrator, PROMedSRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, PROMedSRobustKnownPositionAndInstantMagnetometerCalibrator, PROSACRobustKnownFrameMagnetometerCalibrator, PROSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, PROSACRobustKnownPositionAndInstantMagnetometerCalibrator, RANSACRobustKnownFrameMagnetometerCalibrator, RANSACRobustKnownMagneticFluxDensityNormMagnetometerCalibrator, RANSACRobustKnownPositionAndInstantMagnetometerCalibrator, RobustKnownFrameMagnetometerCalibrator, RobustKnownMagneticFluxDensityNormMagnetometerCalibrator, RobustKnownPositionAndInstantMagnetometerCalibrator
public interface UnknownHardIronNonLinearMagnetometerCalibrator extends UnknownHardIronMagnetometerCalibrator
Interface for non-linear magnetometer calibrator where hard-iron bias is unknown and needs to be estimated.

  • Method Details

    • getInitialHardIronX

      double getInitialHardIronX()
      Gets initial x-coordinate of magnetometer hard-iron bias to be used to find a solution. This is expressed in Teslas (T).
      Returns:
      initial x-coordinate of magnetometer hard-iron bias.

    • setInitialHardIronX

      void setInitialHardIronX(double initialHardIronX) throws com.irurueta.navigation.LockedException
      Sets initial x-coordinate of magnetometer hard-iron bias to be used to find a solution. This is expressed in Teslas (T).
      Parameters:
      initialHardIronX - initial x-coordinate of magnetometer hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialHardIronY

      double getInitialHardIronY()
      Gets initial y-coordinate of magnetometer hard-iron bias to be used to find a solution. This is expressed in Teslas (T).
      Returns:
      initial y-coordinate of magnetometer hard-iron bias.

    • setInitialHardIronY

      void setInitialHardIronY(double initialHardIronY) throws com.irurueta.navigation.LockedException
      Sets initial y-coordinate of magnetometer hard-iron bias to be used to find a solution. This is expressed in Teslas (T).
      Parameters:
      initialHardIronY - initial y-coordinate of magnetometer hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialHardIronZ

      double getInitialHardIronZ()
      Gets initial z-coordinate of magnetometer hard-iron bias to be used to find a solution. This is expressed in Teslas (T).
      Returns:
      initial z-coordinate of magnetometer hard-iron bias.

    • setInitialHardIronZ

      void setInitialHardIronZ(double initialHardIronZ) throws com.irurueta.navigation.LockedException
      Sets initial z-coordinate of magnetometer hard-iron bias to be used to find a solution. This is expressed in meters Teslas (T).
      Parameters:
      initialHardIronZ - initial z-coordinate of magnetometer hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialHardIronXAsMagneticFluxDensity

      com.irurueta.units.MagneticFluxDensity getInitialHardIronXAsMagneticFluxDensity()
      Gets initial x-coordinate of magnetometer hard iron bias to be used to find a solution.
      Returns:
      initial x-coordinate of magnetometer hard-iron bias.

    • getInitialHardIronXAsMagneticFluxDensity

      void getInitialHardIronXAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets initial x-coordinate of magnetometer hard iron bias to be used to find a solution.
      Parameters:
      result - instance where result will be stored.

    • setInitialHardIronX

      void setInitialHardIronX(com.irurueta.units.MagneticFluxDensity initialHardIronX) throws com.irurueta.navigation.LockedException
      Sets initial x-coordinate of magnetometer hard iron bias to be used to find a solution.
      Parameters:
      initialHardIronX - initial x-coordinate of magnetometer bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialHardIronYAsMagneticFluxDensity

      com.irurueta.units.MagneticFluxDensity getInitialHardIronYAsMagneticFluxDensity()
      Gets initial y-coordinate of magnetometer hard iron bias to be used to find a solution.
      Returns:
      initial y-coordinate of magnetometer hard-iron bias.

    • getInitialHardIronYAsMagneticFluxDensity

      void getInitialHardIronYAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets initial y-coordinate of magnetometer hard iron bias to be used to find a solution.
      Parameters:
      result - instance where result will be stored.

    • setInitialHardIronY

      void setInitialHardIronY(com.irurueta.units.MagneticFluxDensity initialHardIronY) throws com.irurueta.navigation.LockedException
      Sets initial y-coordinate of magnetometer hard iron bias to be used to find a solution.
      Parameters:
      initialHardIronY - initial y-coordinate of magnetometer bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialHardIronZAsMagneticFluxDensity

      com.irurueta.units.MagneticFluxDensity getInitialHardIronZAsMagneticFluxDensity()
      Gets initial z-coordinate of magnetometer hard iron bias to be used to find a solution.
      Returns:
      initial z-coordinate of magnetometer hard-iron bias.

    • getInitialHardIronZAsMagneticFluxDensity

      void getInitialHardIronZAsMagneticFluxDensity(com.irurueta.units.MagneticFluxDensity result)
      Gets initial z-coordinate of magnetometer hard iron bias to be used to find a solution.
      Parameters:
      result - instance where result will be stored.

    • setInitialHardIronZ

      void setInitialHardIronZ(com.irurueta.units.MagneticFluxDensity initialHardIronZ) throws com.irurueta.navigation.LockedException
      Sets initial z-coordinate of magnetometer hard iron bias to be used to find a solution.
      Parameters:
      initialHardIronZ - initial z-coordinate of magnetometer bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • setInitialHardIron

      void setInitialHardIron(double initialHardIronX, double initialHardIronY, double initialHardIronZ) throws com.irurueta.navigation.LockedException
      Sets initial hard-iron bias coordinates of magnetometer used to find a solution expressed in Teslas (T).
      Parameters:
      initialHardIronX - initial x-coordinate of magnetometer hard-iron bias.
      initialHardIronY - initial y-coordinate of magnetometer hard-iron bias.
      initialHardIronZ - initial z-coordinate of magnetometer hard-iron bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • setInitialHardIron

      void setInitialHardIron(com.irurueta.units.MagneticFluxDensity initialHardIronX, com.irurueta.units.MagneticFluxDensity initialHardIronY, com.irurueta.units.MagneticFluxDensity initialHardIronZ) throws com.irurueta.navigation.LockedException
      Sets initial hard iron coordinates of magnetometer used to find a solution.
      Parameters:
      initialHardIronX - initial x-coordinate of magnetometer bias.
      initialHardIronY - initial y-coordinate of magnetometer bias.
      initialHardIronZ - initial z-coordinate of magnetometer bias.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialHardIronAsTriad

      MagneticFluxDensityTriad getInitialHardIronAsTriad()
      Gets initial hard-iron used to find a solution.
      Returns:
      initial hard-iron.

    • getInitialHardIronAsTriad

      void getInitialHardIronAsTriad(MagneticFluxDensityTriad result)
      Gets initial hard-iron used to find a solution.
      Parameters:
      result - instance where result will be stored.

    • setInitialHardIron

      void setInitialHardIron(MagneticFluxDensityTriad initialHardIron) throws com.irurueta.navigation.LockedException
      Sets initial hard-iron used to find a solution.
      Parameters:
      initialHardIron - initial hard-iron to be set.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.

    • getInitialHardIron

      double[] getInitialHardIron()
      Gets initial hard-iron bias to be used to find a solution as an array. Array values are expressed in Teslas (T).
      Returns:
      array containing coordinates of initial bias.

    • getInitialHardIron

      void getInitialHardIron(double[] result)
      Gets initial hard-iron bias to be used to find a solution as an array. Array values are expressed in Teslas (T).
      Parameters:
      result - instance where result data will be copied to.
      Throws:
      IllegalArgumentException - if provided array does not have length 3.

    • setInitialHardIron

      void setInitialHardIron(double[] initialHardIron) throws com.irurueta.navigation.LockedException
      Sets initial hard-iron bias to be used to find a solution as an array. Array values are expressed in Teslas (T).
      Parameters:
      initialHardIron - initial hard-iron to find a solution.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.
      IllegalArgumentException - if provided array does not have length 3.

    • getInitialHardIronAsMatrix

      com.irurueta.algebra.Matrix getInitialHardIronAsMatrix()
      Gets initial hard-iron bias to be used to find a solution as a column matrix.
      Returns:
      initial hard-iron bias to be used to find a solution as a column matrix.

    • getInitialHardIronAsMatrix

      void getInitialHardIronAsMatrix(com.irurueta.algebra.Matrix result)
      Gets initial hard-iron bias to be used to find a solution as a column matrix.
      Parameters:
      result - instance where result data will be copied to.
      Throws:
      IllegalArgumentException - if provided matrix is not 3x1.

    • setInitialHardIron

      void setInitialHardIron(com.irurueta.algebra.Matrix initialHardIron) throws com.irurueta.navigation.LockedException
      Sets initial hard-iron bias to be used to find a solution as an array.
      Parameters:
      initialHardIron - initial hard-iron bias to find a solution.
      Throws:
      com.irurueta.navigation.LockedException - if calibrator is currently running.
      IllegalArgumentException - if provided matrix is not 3x1.