#include <signalk_orientation.h>

Public Attributes
bool	is_data_valid
	Indicates whether data are valid.

float	magnetic_inclination

float	cal_fit_error

float	cal_fit_error_trial

float	mag_field_magnitude

float	mag_field_magnitude_trial

float	mag_noise_covariance

int	mag_solver

Detailed Description

MagCal struct contains the values relating to magnetic calibration from the orientation sensor-fusion algorithm. These assist the user in deciding whether the in-use magnetic calibration is suitable or whether the current trial calibration is an improvement. The trial calibration is continuously-updated based on recent magnetic readings.

Definition at line 39 of file signalk_orientation.h.

Member Data Documentation

◆ cal_fit_error

float MagCal::cal_fit_error

error in current calibration's fit, expressed as percent ratio

Definition at line 43 of file signalk_orientation.h.

◆ cal_fit_error_trial

float MagCal::cal_fit_error_trial

error in trial calibration's fit, expressed as percent ratio

Definition at line 45 of file signalk_orientation.h.

◆ is_data_valid

bool MagCal::is_data_valid

Indicates whether data are valid.

Definition at line 40 of file signalk_orientation.h.

◆ mag_field_magnitude

float MagCal::mag_field_magnitude

geomagnetic field magnitude used in current calibration, in T

Definition at line 47 of file signalk_orientation.h.

◆ mag_field_magnitude_trial

float MagCal::mag_field_magnitude_trial

geomagnetic field magnitude based on recent readings, in T

Definition at line 49 of file signalk_orientation.h.

◆ mag_noise_covariance

float MagCal::mag_noise_covariance

covariance of magnetic noise of current reading TODO check units

Definition at line 51 of file signalk_orientation.h.

◆ mag_solver

int MagCal::mag_solver

solver used for current magnetic calibration. Unitless, in set [0,4,7,10]

Definition at line 53 of file signalk_orientation.h.

◆ magnetic_inclination

float MagCal::magnetic_inclination

Magnetic field inclination from horizontal in radians.

Definition at line 41 of file signalk_orientation.h.

The documentation for this struct was generated from the following file:

src/signalk_orientation.h

Public Attributes