mars::MagSensorClass Class Reference

#include </home/runner/work/mars_lib/mars_lib/source/mars/include/mars/sensors/mag/mag_sensor_class.h>

Inheritance diagram for mars::MagSensorClass:

Collaboration diagram for mars::MagSensorClass:

Public Member Functions
EIGEN_MAKE_ALIGNED_OPERATOR_NEW	MagSensorClass (const std::string &name, std::shared_ptr< CoreState > core_states)
virtual	~MagSensorClass ()=default
MagSensorStateType	get_state (const std::shared_ptr< void > &sensor_data)
Eigen::MatrixXd	get_covariance (const std::shared_ptr< void > &sensor_data)
	get_covariance Resolves a void pointer to the covariance matrix of the corresponding sensor type Each sensor is responsible to cast its own data type
void	set_initial_calib (std::shared_ptr< void > calibration)
	set_initial_calib Sets the calibration of an individual sensor
BufferDataType	Initialize (const Time &timestamp, std::shared_ptr< void >, std::shared_ptr< CoreType > latest_core_data)
	Initialize the state of an individual sensor.
bool	CalcUpdate (const Time &, std::shared_ptr< void > measurement, const CoreStateType &prior_core_state, std::shared_ptr< void > latest_sensor_data, const Eigen::MatrixXd &prior_cov, BufferDataType *new_state_data)
	CalcUpdate Calculates the update for an individual sensor definition.
MagSensorStateType	ApplyCorrection (const MagSensorStateType &prior_sensor_state, const Eigen::MatrixXd &correction)
void	set_normalize (const bool &value)
void	set_apply_intrinsic (const bool &value)
void	set_intr_offset (const Eigen::Vector3d &v_offset)
void	set_intr_transform (const Eigen::Matrix3d &m_transform)
Public Member Functions inherited from mars::SensorInterface
virtual EIGEN_MAKE_ALIGNED_OPERATOR_NEW	~SensorInterface ()=default

Private Attributes
bool	normalize_ { false }
	The measurement will be normalized if True.
bool	apply_intrinsic_ { false }
	The intrinsic calibration will be aplied if True.
Eigen::Vector3d	mag_intr_offset_ { Eigen::Vector3d::Zero() }
	Intrinsic cal offset.
Eigen::Matrix3d	mag_intr_transform_ { Eigen::Matrix3d::Identity() }
	Intrinsic cal distortion.

Additional Inherited Members
Public Attributes inherited from mars::UpdateSensorAbsClass
EIGEN_MAKE_ALIGNED_OPERATOR_NEW int	aux_states_
int	aux_error_states_
int	ref_to_nav_
Eigen::MatrixXd	residual_
Eigen::VectorXd	R_
	Measurement noise "squared".
Eigen::MatrixXd	F_
Eigen::MatrixXd	H_
Eigen::MatrixXd	Q_
std::shared_ptr< void >	initial_calib_ { nullptr }
bool	initial_calib_provided_ { false }
	True if an initial calibration was provided.
Chi2	chi2_
std::shared_ptr< CoreState >	core_states_
Public Attributes inherited from mars::SensorAbsClass
int	id_ { -1 }
std::string	name_
	Name of the individual sensor instance.
bool	is_initialized_ { false }
	True if the sensor has been initialized.
bool	do_update_ { true }
	True if updates should be performed with the sensor.
int	type_ { -1 }
	Future feature, holds information such as position or orientation for highlevel decissions.
bool	const_ref_to_nav_ { true }
	True if the reference should not be estimated.
bool	ref_to_nav_given_ { false }
	True if the reference to the navigation frame is given by initial calibration.
bool	use_dynamic_meas_noise_ { false }
	True if dynamic noise values from measurements should be used.

Constructor & Destructor Documentation

MagSensorClass()

EIGEN_MAKE_ALIGNED_OPERATOR_NEW mars::MagSensorClass::MagSensorClass ( const std::string &  name, std::shared_ptr< CoreState >  core_states  )

inline

  {
    name_ = name;
    core_states_ = std::move(core_states);
    const_ref_to_nav_ = false;
    initial_calib_provided_ = false;
 
    // chi2
    chi2_.set_dof(3);
 
    // Sensor specific information
    // setup_sensor_properties();
    std::cout << "Created: [" << this->name_ << "] Sensor" << std::endl;
  }

Here is the call graph for this function:

~MagSensorClass()

virtual mars::MagSensorClass::~MagSensorClass ( )

virtualdefault

Member Function Documentation

get_state()

MagSensorStateType mars::MagSensorClass::get_state ( const std::shared_ptr< void > &  sensor_data )

inline

  {
    MagSensorData data = *static_cast<MagSensorData*>(sensor_data.get());
    return data.state_;
  }

get_covariance()

Eigen::MatrixXd mars::MagSensorClass::get_covariance ( const std::shared_ptr< void > &  sensor_data )

inlinevirtual

get_covariance Resolves a void pointer to the covariance matrix of the corresponding sensor type Each sensor is responsible to cast its own data type

Parameters

sensor_data

Returns

Covariance matrix contained in the sensor data struct

Implements mars::SensorInterface.

  {
    MagSensorData data = *static_cast<MagSensorData*>(sensor_data.get());
    return data.get_full_cov();
  }

Here is the call graph for this function:

set_initial_calib()

void mars::MagSensorClass::set_initial_calib ( std::shared_ptr< void >  calibration )

inlinevirtual

set_initial_calib Sets the calibration of an individual sensor

Parameters

calibration

Implements mars::SensorInterface.

  {
    initial_calib_ = calibration;
    initial_calib_provided_ = true;
  }

Initialize()

BufferDataType mars::MagSensorClass::Initialize ( const Time &  timestamp, std::shared_ptr< void >  measurement, std::shared_ptr< CoreType >  latest_core_data  )

inlinevirtual

Initialize the state of an individual sensor.

Parameters

timestamp	current timestamp
measurement	current sensor measurement
latest_core_data

Returns

Implements mars::SensorInterface.

  {
    // MagMeasurementType measurement = *static_cast<MagMeasurementType*>(sensor_data.get());
 
    MagSensorData sensor_state;
    std::string calibration_type;
 
    if (this->initial_calib_provided_)
    {
      calibration_type = "Given";
 
      MagSensorData calib = *static_cast<MagSensorData*>(initial_calib_.get());
 
      sensor_state.state_ = calib.state_;
      sensor_state.sensor_cov_ = calib.sensor_cov_;
    }
    else
    {
      calibration_type = "Auto";
      std::cout << "Magnetometer calibration AUTO init not implemented yet" << std::endl;
      exit(EXIT_FAILURE);
    }
 
    // Bypass core state for the returned object
    BufferDataType result(std::make_shared<CoreType>(*latest_core_data.get()),
                          std::make_shared<MagSensorData>(sensor_state));
 
    // TODO (chb)
    // sensor_data.ref_to_nav = 0; //obj.calc_ref_to_nav(measurement, latest_core_state);
 
    is_initialized_ = true;
 
    std::cout << "Info: Initialized [" << name_ << "] with [" << calibration_type << "] Calibration at t=" << timestamp
              << std::endl;
 
    if (!initial_calib_provided_)
    {
      std::cout << "Info: [" << name_ << "] Calibration(rounded):" << std::endl;
      std::cout << "\tMag Vector []: [" << sensor_state.state_.mag_.transpose() << " ]" << std::endl;
      std::cout << "\tOrientation Mag in IMU [deg]: ["
                << sensor_state.state_.q_im_.toRotationMatrix().eulerAngles(0, 1, 2).transpose() * (180 / M_PI) << " ]"
                << std::endl;
    }
 
    return result;
  }

CalcUpdate()

bool mars::MagSensorClass::CalcUpdate ( const Time &  timestamp, std::shared_ptr< void >  measurement, const CoreStateType &  prior_core_state_data, std::shared_ptr< void >  latest_sensor_data, const Eigen::MatrixXd &  prior_cov, BufferDataType *  new_state_data  )

inlinevirtual

CalcUpdate Calculates the update for an individual sensor definition.

Parameters

timestamp	current timestamp
measurement	current sensor measurement
prior_core_state_data
latest_sensor_data
prior_cov	Prior covariance containing core, sensor and sensor cross covariance
new_state_data	Updated state data

Returns

True if the update was successful, false if the update was rejected

Implements mars::SensorInterface.

  {
    // Cast the sensor measurement and prior state information
    MagMeasurementType* meas = static_cast<MagMeasurementType*>(measurement.get());
    MagSensorData* prior_sensor_data = static_cast<MagSensorData*>(latest_sensor_data.get());
 
    // Decompose sensor measurement
    Eigen::Vector3d mag_meas(meas->mag_vector_);
 
    // Correct measurement with intrinsic calibration
    if (apply_intrinsic_)
    {
      mag_meas = mag_intr_transform_ * (mag_meas - mag_intr_offset_);
    }
 
    // Perform normalization
    if (normalize_)
    {
      mag_meas = mag_meas / mag_meas.norm();
    }
 
    // Extract sensor state
    MagSensorStateType prior_sensor_state(prior_sensor_data->state_);
 
    // Generate measurement noise matrix and check
    // if noisevalues from the measurement object should be used
    Eigen::MatrixXd R_meas_dyn;
    if (meas->has_meas_noise && use_dynamic_meas_noise_)
    {
      meas->get_meas_noise(&R_meas_dyn);
    }
    else
    {
      R_meas_dyn = this->R_.asDiagonal();
    }
    const Eigen::Matrix<double, 3, 3> R_meas = R_meas_dyn;
 
    const int size_of_core_state = CoreStateType::size_error_;
    const int size_of_sensor_state = prior_sensor_state.cov_size_;
    const int size_of_full_error_state = size_of_core_state + size_of_sensor_state;
    const Eigen::MatrixXd P = prior_cov;
    assert(P.size() == size_of_full_error_state * size_of_full_error_state);
 
    // Calculate the measurement jacobian H
    // const Eigen::Matrix3d I_3 = Eigen::Matrix3d::Identity();
    const Eigen::Matrix3d R_wi = prior_core_state.q_wi_.toRotationMatrix();
    const Eigen::Vector3d mag_w = prior_sensor_state.mag_;
    const Eigen::Matrix3d R_im = prior_sensor_state.q_im_.toRotationMatrix();
 
    // Orientation
    const Eigen::Matrix3d Hm_pwi = Eigen::Matrix3d::Zero();
    const Eigen::Matrix3d Hm_vwi = Eigen::Matrix3d::Zero();
    const Eigen::Matrix3d Hm_rwi = R_im.transpose() * Utils::Skew(R_wi.transpose() * mag_w);
    const Eigen::Matrix3d Hm_bw = Eigen::Matrix3d::Zero();
    const Eigen::Matrix3d Hm_ba = Eigen::Matrix3d::Zero();
    const Eigen::Matrix3d Hm_mag = R_im.transpose() * R_wi.transpose();
    const Eigen::Matrix3d Hm_rim = Utils::Skew(R_im.transpose() * R_wi.transpose() * mag_w);
 
    // Assemble the jacobian for the orientation (horizontal)
    // H_r = [Hr_pwi Hr_vwi Hr_rwi Hr_bw Hr_ba Hr_mag Hr_rim];
    Eigen::MatrixXd H(3, Hm_pwi.cols() + Hm_vwi.cols() + Hm_rwi.cols() + Hm_bw.cols() + Hm_ba.cols() + Hm_mag.cols() +
                             Hm_rim.cols());
    H << Hm_pwi, Hm_vwi, Hm_rwi, Hm_bw, Hm_ba, Hm_mag, Hm_rim;
 
    // Calculate the residual z = z~ - (estimate)
    // Position
    const Eigen::Vector3d mag_est = R_im.transpose() * R_wi.transpose() * mag_w;
    residual_ = Eigen::MatrixXd(mag_est.rows(), 1);
    residual_ = mag_meas - mag_est;
 
    // Perform EKF calculations
    mars::Ekf ekf(H, R_meas, residual_, P);
    const Eigen::MatrixXd correction = ekf.CalculateCorrection(&chi2_);
    assert(correction.size() == size_of_full_error_state * 1);
 
    // Perform Chi2 test
    if (!chi2_.passed_ && chi2_.do_test_)
    {
      chi2_.PrintReport(name_);
      return false;
    }
 
    Eigen::MatrixXd P_updated = ekf.CalculateCovUpdate();
    assert(P_updated.size() == size_of_full_error_state * size_of_full_error_state);
    P_updated = Utils::EnforceMatrixSymmetry(P_updated);
 
    // Apply Core Correction
    CoreStateVector core_correction = correction.block(0, 0, CoreStateType::size_error_, 1);
    CoreStateType corrected_core_state = CoreStateType::ApplyCorrection(prior_core_state, core_correction);
 
    // Apply Sensor Correction
    const Eigen::MatrixXd sensor_correction = correction.block(size_of_core_state, 0, size_of_sensor_state, 1);
    const MagSensorStateType corrected_sensor_state = ApplyCorrection(prior_sensor_state, sensor_correction);
 
    // Return Results
    // CoreState data
    CoreType core_data;
    core_data.cov_ = P_updated.block(0, 0, CoreStateType::size_error_, CoreStateType::size_error_);
    core_data.state_ = corrected_core_state;
 
    // SensorState data
    std::shared_ptr<MagSensorData> sensor_data(std::make_shared<MagSensorData>());
    sensor_data->set_cov(P_updated);
    sensor_data->state_ = corrected_sensor_state;
 
    BufferDataType state_entry(std::make_shared<CoreType>(core_data), sensor_data);
 
    if (const_ref_to_nav_)
    {
      // corrected_sensor_data.ref_to_nav = prior_ref_to_nav;
    }
    else
    {
      // TODO(chb) also estimate ref to nav
    }
 
    *new_state_data = state_entry;
 
    return true;
  }

Here is the call graph for this function:

ApplyCorrection()

MagSensorStateType mars::MagSensorClass::ApplyCorrection ( const MagSensorStateType &  prior_sensor_state, const Eigen::MatrixXd &  correction  )

inline

  {
    // state + error state correction
    // with quaternion from small angle approx -> new state
 
    MagSensorStateType corrected_sensor_state;
    corrected_sensor_state.mag_ = prior_sensor_state.mag_ + correction.block(0, 0, 3, 1);
    corrected_sensor_state.q_im_ =
        Utils::ApplySmallAngleQuatCorr(prior_sensor_state.q_im_, correction.block(3, 0, 3, 1));
    return corrected_sensor_state;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

set_normalize()

void mars::MagSensorClass::set_normalize ( const bool &  value )

inline

  {
    normalize_ = value;
  }

set_apply_intrinsic()

void mars::MagSensorClass::set_apply_intrinsic ( const bool &  value )

inline

  {
    apply_intrinsic_ = value;
  }

set_intr_offset()

void mars::MagSensorClass::set_intr_offset ( const Eigen::Vector3d &  v_offset )

inline

  {
    mag_intr_offset_ = v_offset;
  }

set_intr_transform()

void mars::MagSensorClass::set_intr_transform ( const Eigen::Matrix3d &  m_transform )

inline

  {
    mag_intr_transform_ = m_transform;
  }

Member Data Documentation

normalize_

bool mars::MagSensorClass::normalize_ { false }

private

The measurement will be normalized if True.

{ false };                                     

apply_intrinsic_

bool mars::MagSensorClass::apply_intrinsic_ { false }

private

The intrinsic calibration will be aplied if True.

{ false };                               

mag_intr_offset_

Eigen::Vector3d mars::MagSensorClass::mag_intr_offset_ { Eigen::Vector3d::Zero() }

private

Intrinsic cal offset.

{ Eigen::Vector3d::Zero() };  

mag_intr_transform_

Eigen::Matrix3d mars::MagSensorClass::mag_intr_transform_ { Eigen::Matrix3d::Identity() }

private

Intrinsic cal distortion.

{ Eigen::Matrix3d::Identity() };  

---

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

• mag_sensor_class.h