MIP_SDK  v3.0.0
MicroStrain Communications Library for embedded systems
Classes | Functions
(0x0C,0x3B) Mag Soft Iron Matrix

Configure the user specified magnetometer soft iron offset matrix. More...

Classes

struct  mip::commands_3dm::MagSoftIronMatrix
 

Functions

TypedResult< MagSoftIronMatrixmip::commands_3dm::writeMagSoftIronMatrix (C::mip_interface &device, const float *offset)
 
TypedResult< MagSoftIronMatrixmip::commands_3dm::readMagSoftIronMatrix (C::mip_interface &device, float *offsetOut)
 
TypedResult< MagSoftIronMatrixmip::commands_3dm::saveMagSoftIronMatrix (C::mip_interface &device)
 
TypedResult< MagSoftIronMatrixmip::commands_3dm::loadMagSoftIronMatrix (C::mip_interface &device)
 
TypedResult< MagSoftIronMatrixmip::commands_3dm::defaultMagSoftIronMatrix (C::mip_interface &device)
 

Detailed Description

Configure the user specified magnetometer soft iron offset matrix.

The values for this matrix are determined empirically by external software algorithms based on calibration data taken after the device is installed in its application. These values can be obtained and set by using Microstrain software tools. Alternatively, on some systems, the auto-mag calibration feature may be used to capture these values in-run. The matrix is applied to the scaled magnetometer vector prior to output.

The matrix is in row major order: EQSTART M = \begin{bmatrix} 0 & 1 & 2 \\ 3 & 4 & 5 \\ 6 & 7 & 8 \end{bmatrix} EQEND

Function Documentation

◆ defaultMagSoftIronMatrix()

TypedResult< MagSoftIronMatrix > mip::commands_3dm::defaultMagSoftIronMatrix ( C::mip_interface device)

◆ loadMagSoftIronMatrix()

TypedResult< MagSoftIronMatrix > mip::commands_3dm::loadMagSoftIronMatrix ( C::mip_interface device)

◆ readMagSoftIronMatrix()

TypedResult< MagSoftIronMatrix > mip::commands_3dm::readMagSoftIronMatrix ( C::mip_interface device,
float *  offsetOut 
)

◆ saveMagSoftIronMatrix()

TypedResult< MagSoftIronMatrix > mip::commands_3dm::saveMagSoftIronMatrix ( C::mip_interface device)

◆ writeMagSoftIronMatrix()

TypedResult< MagSoftIronMatrix > mip::commands_3dm::writeMagSoftIronMatrix ( C::mip_interface device,
const float *  offset 
)