Larus glider flight sensor system 3.9.2024
Software-In-The-Loop test and validation system
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
compass_calibration_t< sample_type, evaluation_type > Class Template Reference

Maintains 3 axes magnetic calibration data. More...

#include <compass_calibration.h>

Collaboration diagram for compass_calibration_t< sample_type, evaluation_type >:
Collaboration graph
[legend]

Public Member Functions

 compass_calibration_t (void)
 
float3vector calibrate (const float3vector &in)
 
bool set_default (void)
 
bool set_calibration_if_changed (linear_least_square_fit< sample_type, evaluation_type > mag_calibrator_right[3], linear_least_square_fit< sample_type, evaluation_type > mag_calibrator_left[3], float scale_factor)
 
bool available () const
 
const single_axis_calibration_t * get_calibration (void) const
 
bool parameters_changed_significantly (single_axis_calibration_t const *new_calibration) const
 
void write_into_EEPROM (void) const
 
bool read_from_EEPROM (void)
 

Public Attributes

single_axis_calibration_t calibration [3]
 
bool calibration_done
 

Detailed Description

template<class sample_type, class evaluation_type>
class compass_calibration_t< sample_type, evaluation_type >

Maintains 3 axes magnetic calibration data.

Definition at line 72 of file compass_calibration.h.

Constructor & Destructor Documentation

◆ compass_calibration_t()

template<class sample_type , class evaluation_type >
compass_calibration_t< sample_type, evaluation_type >::compass_calibration_t ( void  )
inline

Definition at line 75 of file compass_calibration.h.

Member Function Documentation

◆ available()

template<class sample_type , class evaluation_type >
bool compass_calibration_t< sample_type, evaluation_type >::available ( ) const
inline

Definition at line 148 of file compass_calibration.h.

References compass_calibration_t< sample_type, evaluation_type >::calibration_done.

Referenced by AHRS_type::attitude_setup(), AHRS_type::update_ACC_only(), and AHRS_type::update_compass().

◆ calibrate()

template<class sample_type , class evaluation_type >
float3vector compass_calibration_t< sample_type, evaluation_type >::calibrate ( const float3vector &  in)
inline

Definition at line 79 of file compass_calibration.h.

References compass_calibration_t< sample_type, evaluation_type >::calibrate(), compass_calibration_t< sample_type, evaluation_type >::calibration, and compass_calibration_t< sample_type, evaluation_type >::calibration_done.

Referenced by AHRS_type::attitude_setup(), compass_calibration_t< sample_type, evaluation_type >::calibrate(), AHRS_type::update_ACC_only(), and AHRS_type::update_compass().

◆ get_calibration()

template<class sample_type , class evaluation_type >
const single_axis_calibration_t * compass_calibration_t< sample_type, evaluation_type >::get_calibration ( void  ) const
inline

Definition at line 153 of file compass_calibration.h.

References compass_calibration_t< sample_type, evaluation_type >::calibration, and compass_calibration_t< sample_type, evaluation_type >::calibration_done.

◆ parameters_changed_significantly()

template<class sample_type , class evaluation_type >
bool compass_calibration_t< sample_type, evaluation_type >::parameters_changed_significantly ( single_axis_calibration_t const *  new_calibration) const
inline

Definition at line 158 of file compass_calibration.h.

References compass_calibration_t< sample_type, evaluation_type >::calibration, MAG_OFFSET_CHANGE_LIMIT, and MAG_SCALE_CHANGE_LIMIT.

Referenced by compass_calibration_t< sample_type, evaluation_type >::set_calibration_if_changed().

◆ read_from_EEPROM()

template<class sample_type , class evaluation_type >
bool compass_calibration_t< sample_type, evaluation_type >::read_from_EEPROM ( void  )
inline

Definition at line 191 of file compass_calibration.h.

References compass_calibration_t< sample_type, evaluation_type >::calibration, compass_calibration_t< sample_type, evaluation_type >::calibration_done, read_EEPROM_value(), SQR, and single_axis_calibration_t::variance.

◆ set_calibration_if_changed()

template<class sample_type , class evaluation_type >
bool compass_calibration_t< sample_type, evaluation_type >::set_calibration_if_changed ( linear_least_square_fit< sample_type, evaluation_type >  mag_calibrator_right[3],
linear_least_square_fit< sample_type, evaluation_type >  mag_calibrator_left[3],
float  scale_factor 
)
inline

Definition at line 108 of file compass_calibration.h.

References compass_calibration_t< sample_type, evaluation_type >::calibration, MINIMUM_MAG_CALIBRATION_SAMPLES, compass_calibration_t< sample_type, evaluation_type >::parameters_changed_significantly(), SQR, and TWO.

◆ set_default()

template<class sample_type , class evaluation_type >
bool compass_calibration_t< sample_type, evaluation_type >::set_default ( void  )
inline

Definition at line 92 of file compass_calibration.h.

References compass_calibration_t< sample_type, evaluation_type >::calibration, compass_calibration_t< sample_type, evaluation_type >::calibration_done, single_axis_calibration_t::offset, single_axis_calibration_t::scale, and single_axis_calibration_t::variance.

◆ write_into_EEPROM()

template<class sample_type , class evaluation_type >
void compass_calibration_t< sample_type, evaluation_type >::write_into_EEPROM ( void  ) const
inline

Definition at line 174 of file compass_calibration.h.

References compass_calibration_t< sample_type, evaluation_type >::calibration, compass_calibration_t< sample_type, evaluation_type >::calibration_done, EEPROM_initialize(), SQRT, single_axis_calibration_t::variance, and write_EEPROM_value().

Referenced by AHRS_type::write_calibration_into_EEPROM().

Member Data Documentation

◆ calibration

template<class sample_type , class evaluation_type >
single_axis_calibration_t compass_calibration_t< sample_type, evaluation_type >::calibration[3]

Definition at line 214 of file compass_calibration.h.

Referenced by compass_calibration_t< sample_type, evaluation_type >::calibrate(), compass_calibration_t< sample_type, evaluation_type >::get_calibration(), compass_calibration_t< sample_type, evaluation_type >::parameters_changed_significantly(), compass_calibration_t< sample_type, evaluation_type >::read_from_EEPROM(), compass_calibration_t< sample_type, evaluation_type >::set_calibration_if_changed(), compass_calibration_t< sample_type, evaluation_type >::set_default(), and compass_calibration_t< sample_type, evaluation_type >::write_into_EEPROM().

◆ calibration_done

template<class sample_type , class evaluation_type >
bool compass_calibration_t< sample_type, evaluation_type >::calibration_done

Definition at line 215 of file compass_calibration.h.

Referenced by compass_calibration_t< sample_type, evaluation_type >::available(), compass_calibration_t< sample_type, evaluation_type >::calibrate(), compass_calibration_t< sample_type, evaluation_type >::get_calibration(), compass_calibration_t< sample_type, evaluation_type >::read_from_EEPROM(), compass_calibration_t< sample_type, evaluation_type >::set_default(), and compass_calibration_t< sample_type, evaluation_type >::write_into_EEPROM().

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