The Modular and Robust State-Estimation Framework, or short, MaRS, is a recursive filtering framework that allows for truly modular multi-sensor integration. The framework further enables the handling of multiple sensors dynamically and performs self-calibration if auxiliary states are defined for the respective sensor module.
Features:
- Truly-Modular decoupling of Sensor-States from the essential Navigation-States
- Generalized covariance segmentation for Plug and Play state and covariance blocks
- Minimal State-Representation at any point in time
- Integration and removal of sensor modules during runtime
- Out of sequence sensor measurement handling
- Developed for computationally constrained platforms
- Efficient handling of asynchronous and multi-rate sensor information
- Separation between simple user interaction and the complexity of information handling
Patents:
- Austrian patent published A 50969
- U.S. patent pending US2022/0146264A1
Code Documentation:
- You can find the Doxygen generated code documentation here
Whats New?
- Version 2.0.0: Starting with this version, the MaRS buffer does not require a double entry for measurements and states anymore. A single buffer entry now tracks measurements and states. If no states are generated, e.g. because they are outliers, entries are kept in the buffer and their invalidity is indicated by a meta tag. This renders the buffer logic more lightweight and improves performance. Please refer to the migration guide for API changes.
$ git clone <url> mars_cpp # Get the code
$ cd mars_cpp && mkdir build && cd build # Setup the build dir
$ cmake -DCMAKE_BUILD_TYPE=Release ../ # Run cmake
$ make -j # Build the project$ mkdir mars_ws && cd mars_ws # Setup the workspace
$ git clone <url> mars_cpp # Get the code
$ cd mars_cpp # Navigate to the code
$ qtcreator . # Run QT-Creator and press 'Configure Project'MaRS has four dependencies which are automatically downloaded and linked against:
- Eigen
- yaml-cpp
- G-Test
- Boost
Thus, no dependencies need to be installed by hand.
You can find find the Doxygen generated code documentation, after the project was built, in:
mars_cpp/build/docs/api-docs/html/index.htmlThe MaRS framework has multiple options to perform tests on the code base, individual tests in classes, end-to-end tests with simulated data and isolated compilation for dependency checks.
The test suit mars-test performs tests on all classes and ensures that the member functions perform according to their definition. MaRS also provides two end-to-end tests, which are combined in the mars-e2e-test test suit. The two tests consist of an IMU propagation only scenario and an IMU with pose update scenario. The input for both test cases are synthetically generated datasets, and the end result of the test run is compared to the ground truth.
$ cd build # Enter the build directory and run:
$ make test mars-test # Tests for individual classes
$ make test mars-e2e-test # End to end tests with simulated data| Test Name | Description |
|---|---|
| mars_e2e_imu_prop | IMU propagation only |
| mars_e2e_imu_pose_update | IMU propagation and pose updates (IMU and pose updates are in synch) |
$ cd mars_cpp # Enter the source directory
$ docker build --network=host -t mars_test_env:latest . # Build the Docker image
# The following runs the container, maps the source code (read only)
# and executes the script in 'deploy/scripts/docker_application_test.sh'
$ docker run -it --rm \
--network=host \
-v "$(pwd)":/source:ro \
mars_test_env:latestThe code base is mostly C++ based and follows the C++ Google style convention. A C-Lang file with formating definitions / for auto formatting can be found in the root directory of the project mars_lib/.clang-format.
MaRS uses covariance and state-vector segmentation to allow for a modular structure and the removal and integration of covariance blocks at a given point in time. This method, in particular, allows the removal of the state augmentation for one sensor modality, the processing of the essential navigation states in separation, and the consecutive augmentation of the navigation states as the particular measurements become available. The majority of previous frameworks would carry the state augmentation for each individual sensor at every processing step, which consumes additional computational power.
As an example: The image below, on the left side, shows the layout of a covariance matrix for a system with three main components. The components are the Navigation States (Core States), a sensor with calibration states (Sensor A), and a second sensor with calibration states (Sensor B). Previous frameworks would handle the full-sized covariance matrix throughout every filtering step which includes, the propagation of the core-states, updates of Sensor A or Sensor B, as well as repropagation in the case of delayed sensor measurements.
The right side of this diagram shows how MaRS is handling the same events. The navigation states are updated in isolation; in the event of a sensor measurement, the corresponding sensor information such as the state, sensor covariance, and cross-correlations with the core states are merged with the core state and updated. During this update step, it's important to notice that the covariance elements of the sensor have not been propagated while the core state has been propagated. The MaRS framework is correcting the individual covariance elements before the merging process.
The same holds for a multi-sensor system in which the update sequence is Sensor A -> Sensor-B -> Sensor-A. The update of Sensor-B would interfere with the straightforward covariance propagation because the covariance of the core state is updated, but the decupled and stored information on Sensor-A was not updated accordingly. MaRS uses Eigen-Value correction to correct for the missing information before updating Sensor-A in a consecutive step. Thus, the properties and coherence of the covariance matrices are guaranteed at all times.
For the full explanation of the technology, please refer to the MaRS Paper here, or watch this video animation on YouTube for an easier understanding of the covariance-segmentation process:
It is important to mention that MaRS makes one particular assumption for this method. As illustrated by the image on the covariance segments above, the Sensor-Core cross-covariances (purple elements) are handled correctly. However, the Sensor-Sensor cross-covariance (gray elements) is assumed to be zero and thus not stored throughout the process.
The MaRS framework is designed such that essential modules are interchangeable, and the definition of the core logic is agnostic to any sensor definition. For this, each component has generically defined interfaces. A simplified Pseudo UML diagram of the system elements is shown below.
This class structure is designed with simplified user-level interaction. This means that components that are likely to change or extended are simple to interact with, and more complex components are less likely the object to modification. The graph below shows the essential components and their complexity level. It's important to mention that changes or the addition of a sensor update module does not require modifications in any other component.
If you are interested in how the actual UML diagram for MaRS looks like, you can have a look at the image below or check out the Doxygen dependency graphs described here.
MaRS has a single buffer that holds all the information needed to operate the framework and to perform out-of-order updates. The data outline of a single buffer entry looks as follows:
Each buffer entry has a timestamp, a Core/Sensor data block, a metadata field for indicating the entry type (e.g., measurement, sensor update, core state), and a reference to the update sensor class instance for processing the Core/Sensor data field.
Note: When using the provided buffer API, the order of buffer entries is guaranteed to be chronological.
MaRS uses type erasure to allow the storage of different sensor types. Even though sensor modules are derived from the same abstract class, the overlaying structure can change for each sensor type. Thus MaRS casts the Core/Sensor data block to a shared void pointer. The referenced sensor module instance is then used to cast the individual type correctly.
Shared pointers are heavily used for this framework, especially for the storage of states and shared usage of the various modules of the framework. The buffer holds shared pointers to the state elements. These elements are referenced in the buffer and passed to sensor instances for processing. The smart pointers are passed to functions that use the move() function to generate a copy of the pointer. This is more efficient, and it makes clear that the particular object is a part-owner of this object.
On particular important feature of shared pointers are shared void pointers. If the last reference to this data element is deleted, then the shared pointer automatically calls the destructor of the void object. Normal pointers to void objects do not follow this behavior. If a normal void pointer goes out of scope, then the referenced data element remains allocated and causes a memory leak.
This property is important for the design of the framework because it makes use of type erasure and thus, stores references to objects as void pointers. Thus, states in the buffer that are removed because they exceed the defined maximal storage of the states in the buffer are destructed automatically.
All measurements are handled in the same fashion, which makes it simple for any middleware integration. As described in this section, a dedicated propagation sensor is defined on system start. Based on this, the system can distinguish between propagation and update sensors. To process any measurement, only the following line needs to be called:
// sensor_sptr: Pointer to the corresponding sensor instance
// timestamp: Measurement timestamp
// data: MaRS buffer data element
core_logic_.ProcessMeasurement(sensor_sptr, timestamp, data)This is the content of any MaRS buffer entry and needs to be available on e.g., a callback triggered by a specific sensor. Within the ProcessMeasurement(...) function, MaRS divides the process for propagation and updates and performs the routines shown below. At this point, the framework also applies logic to determine if the measurement is still meaningful to the system (e.g., it could be out of order and too old) and processes out of order updates that are within limits accordingly (see here).
The handling of out-of-order updates within MaRS is straightforward. The general buffer history has one measurement followed by a state update entry. If an out-of-order measurement occurs, it's added to the buffer depending on its timestamp. All following state entries up to the current state are deleted (based on the metadata tag), and the measurements are feed to the ProcessMeasurement(...) function to generate the new state updates up to the current time.
MaRS has a second buffer instance that can be used for advanced initialization. All sensor data for propagation or updates can be stored in this buffer and used in a pre-processing step before the actual initialization. By default, the framework uses the latest propagation sensor for initialization. The sequence of events is shown below:
The Navigation-States (core states) are the essential states to localize a robot in the world, given the fact that these states are propagated with IMU measurements.
The translation
| Symbol | Description |
|---|---|
| Navigation State | |
| Translation of the robot IMU/body frame expressed w.r.t. the world frame | |
| Velocity of the robot IMU/body frame expressed w.r.t. the world frame | |
| Orientation of the robot IMU/body frame expressed w.r.t. the world frame (Hamiltonian) | |
| Gyroscopic bias | |
| Accelerometer bias | |
| Zero mean white Gaussian noise of the gyroscope measurement | |
| Zero mean white Gaussian noise of the accelerometer measurement | |
| The right side Quaternion multiplication matrix for |
New sensor modules can be added in a simple and straightforward fashion. Please consult the Tutorial section on how to use existing sensor modules and how to implement new sensor modules. Please find a list of pre-defined sensor modules below.
Symbols:
| Symbol | Definition |
|---|---|
| Translation of the position sensor w.r.t. the robot IMU/body frame |
Measurement equation:
Symbols:
| Symbol | Definition |
|---|---|
| Translation of the pose sensor w.r.t. the robot IMU/body frame | |
| Orientation of the pose sensors w.r.t. the robot IMU/body frame |
Measurement equation:
Symbols:
| Symbol | Definition |
|---|---|
| Translation of the vision world frame w.r.t. the world frame | |
| Orientation of the vision world frame w.r.t. the world frame | |
| Translation of the camera sensor w.r.t. the robot IMU/body frame | |
| Vision scale |
Measurement equation:
Symbols:
| Symbol | Definition |
|---|---|
| Translation of the GNSS world frame w.r.t. the world frame | |
| Orientation of the GNSS world frame w.r.t. the world frame | |
| Translation of the GNSS sensor w.r.t. the robot IMU/body frame |
Measurement equation:
Symbols:
| Symbol | Definition |
|---|---|
| Rotation of the IMU/Body frame expressed w.r.t. the world frame | |
| Velocity of the IMU/Body frame expressed w.r.t. the world frame | |
| Translation of the GNSS sensor w.r.t. the robot IMU/body frame | |
| Angular velocity of the IMU/Body frame |
with
for alignment with the x-axis, and
Thus
Leading to the following derivatives
Symbols:
| Symbol | Definition |
|---|---|
| Orientation of the Magnetometer w.r.t. the robot IMU/body frame | |
| Magnetic field vector expressed in the world frame |
Measurement equation:
Symbols:
| Symbol | Definition |
|---|---|
| Translation of the pressure sensor w.r.t. the robot IMU/body frame |
Measurement equation:
Symbols:
| Symbol | Definition |
|---|---|
| Translation of the bodyvel sensor w.r.t. the robot IMU/body frame | |
| Orientation of the bodyvel sensor w.r.t. the robot IMU/body frame | |
| Angular velocity of the IMU/Body frame |
Measurement equation:
Symbols:
| Symbol | Definition |
|---|---|
| Orientation of the attitude origin w.r.t. the world/global frame | |
| Orientation of the attitude sensor w.r.t. the robot IMU/body frame |
Measurement equation:
Individual symbols are described in section Symbols and sensor states are described in section Provided Sensor Modules (Plug and Play)
| Sensor | CSV File Column Entries |
|---|---|
| IMU | [time, a_x, a_y, a_z, w_x, w_y, w_z] |
| Position Sensor | [time, p_x, p_y, p_z] |
| Pose Sensor | [time, p_x, p_y, p_z, q_w, q_x, q_y, q_z] |
| Vision Sensor | [time, p_x, p_y, p_z, q_w, q_x, q_y, q_z] |
| GNSS | [time, lat, long, alt] |
| GNSS with Velocity | [time, lat, long, alt, v_x, v_y, v_z] |
| Magnetometer | [time, m_x, m_y, m_z] |
| Pressure Sensor | [time, pressure] |
| Sensor | CSV File Column Entries |
|---|---|
| Core States | [time, w_x, w_y, w_z, a_x, a_y, a_z, p_wi_x, p_wi_y, p_wi_z, v_x, v_y, v_z, q_wi_w, q_wi_x, q_wi_y, q_wi_z, bw_x, bw_y, bw_z, ba_x, ba_y, ba_z] |
| Position Sensor | [time, p_ip_x, p_ip_y, p_ip_z] |
| Pose Sensor | [time, p_ip_x, p_ip_y, p_ip_z, q_ip_w, q_ip_x, q_ip_y, q_ip_z] |
| Vision Sensor | [time, p_ip_x, p_ip_y, p_ip_z, q_ip_w, q_ip_x, q_ip_y, q_ip_z] |
| GNSS | [time, p_ig_x, p_ig_y, p_ig_z, p_gw_w_x, p_gw_w_y, p_gw_w_z, q_gw_w_w, q_gw_w_x, q_gw_w_y, q_gw_w_z] |
| GNSS with Velocity | [time, p_ig_x, p_ig_y, p_ig_z, p_gw_w_x, p_gw_w_y, p_gw_w_z, q_gw_w_w, q_gw_w_x, q_gw_w_y, q_gw_w_z] |
| Magnetometer | [time, mag_w_x, mag_w_y, mag_w_z, q_im_w, q_im_x, q_im_y, q_im_z] |
| Pressure Sensor | [time, p_ip_x, p_ip_y, p_ip_z, bias] |
Generated with tree -a -L 3 --noreport --charset unicode > layout.md
├── CMakeLists.txt
├── include
│  └── mars
│  ├── buffer.h
│  ├── core_logic.h
│  ├── core_state.h
│  ├── data_utils
│  │  ├── read_csv.h
│  │  ├── read_pose_data.h
│  │  └── read_sim_data.h
│  ├── ekf.h
│  ├── general_functions
│  │  └── utils.h
│  ├── mars_api.h
│  ├── mars_export.h
│  ├── mars_features.h
│  ├── nearest_cov.h
│  ├── sensor_manager.h
│  ├── sensors
│  │  ├── bind_sensor_data.h
│  │  ├── imu
│  │  │  ├── imu_measurement_type.h
│  │  │  └── imu_sensor_class.h
│  │  ├── pose
│  │  │  ├── pose_measurement_type.cpp
│  │  │  ├── pose_measurement_type.h
│  │  │  ├── pose_sensor_class.cpp
│  │  │  ├── pose_sensor_class.h
│  │  │  ├── pose_sensor_state_type.cpp
│  │  │  └── pose_sensor_state_type.h
│  │  ├── position
│  │  │  └── ...
│  │  ├── sensor_abs_class.h
│  │  ├── sensor_interface.h
│  │  └── update_sensor_abs_class.h
│  ├── TBuffer.h
│  ├── time.h
│  ├── timestamp.h
│  └── type_definitions
│  ├── base_states.h
│  ├── buffer_data_type.h
│  ├── buffer_entry_type.h
│  ├── core_state_type.h
│  └── core_type.h
├── include_local
│  └── mars
│  ├── helper.hpp
│  └── utils.hpp
└── source
├── buffer.cpp
├── buffer_entry_type.cpp
├── core_logic.cpp
├── core_state_calc_q.cpp
├── core_state.cpp
├── ekf.cpp
├── nearest_cov.cpp
├── sensor_abs_class.cpp
├── sensor_interface.cpp
├── sensor_manager.cpp
├── time.cpp
├── timestamp.cpp
└── utils.cpp
This section explains the interaction with the essential components of the MaRS Framework and how to customize components to different state-estimation modularities.
Due to the usage of the MaRS C++ API, the direct use of the MaRS library or using the library within any middleware framework is possible with no significant overhead.
The only difference between the two scenarios is the method in which the data is passed to the framework. To use MaRS without any middleware, you can have a look at one of the end2end tests that MaRS provides and define your own executable in the same fashion. You can use the outline of source/test/mars-e2e-test/mars_e2e_imu_pose_update.cpp as a reference. MaRS already provides methods to read data from a CSV file and store results after processing.
For the implementation of a MaRS wrapper, you can use this project as a reference: MaRS ROS. The sections below make use of code snippets from the MaRS ROS wrapper.
MaRS needs a few persistent component instantiations to operate. The instantiation and association of these components are shown below.
#include <mars/core_logic.h>
#include <mars/core_state.h>
#include <mars/sensors/imu/imu_measurement_type.h>
#include <mars/sensors/imu/imu_sensor_class.h>
#include <mars/sensors/pose/pose_measurement_type.h>
#include <mars/type_definitions/buffer_data_type.h>
#include <mars/type_definitions/buffer_entry_type.h>
#include <mars_msg_conv.h>
#include <sensor_msgs/Imu.h>
#include <Eigen/Dense>
// Setup Framework Components
imu_sensor_sptr_ = std::make_shared<mars::ImuSensorClass>("IMU");
core_states_sptr_ = std::make_shared<mars::CoreState>();
core_states_sptr_.get()->set_propagation_sensor(imu_sensor_sptr_);
core_logic_ = mars::CoreLogic(core_states_sptr_);
core_logic_.buffer_.set_max_buffer_size(800);
core_states_sptr_->set_noise_std(
Eigen::Vector3d(0.013, 0.013, 0.013), Eigen::Vector3d(0.0013, 0.0013, 0.0013),
Eigen::Vector3d(0.083, 0.083, 0.083), Eigen::Vector3d(0.0083, 0.0083, 0.0083));
// Sensor Definition
pose1_sensor_sptr_ = std::make_shared<mars::PoseSensorClass>("Pose1", core_states_sptr_);
Eigen::Matrix<double, 6, 1> pose_meas_std;
pose_meas_std << 0.05, 0.05, 0.05, 3 * (M_PI / 180), 3 * (M_PI / 180), 3 * (M_PI / 180);
pose1_sensor_sptr_->R_ = pose_meas_std.cwiseProduct(pose_meas_std);
// Sensor Calibration
PoseSensorData pose_calibration;
pose_calibration.state_.p_ip_ = Eigen::Vector3d(0.0, 0.0, 0.0);
pose_calibration.state_.q_ip_ = Eigen::Quaterniond::Identity();
Eigen::Matrix<double, 6, 6> pose_cov;
pose_cov.setZero();
pose_cov.diagonal() << 0.0025, 0.0025, 0.0025, 0.0076, 0.0076, 0.0076; // 5cm, 5deg
pose_calibration.sensor_cov_ = pose_cov;
pose1_sensor_sptr_->set_initial_calib(std::make_shared<PoseSensorData>(pose_calibration));
// Sensor Chi2`
pose1_sensor_sptr_->chi2_.set_chi_value(0.05);
pose1_sensor_sptr_->chi2_.ActivateTest(true);imu_sensor_sptr_ = std::make_shared<mars::ImuSensorClass>("IMU");This line initialized the IMU sensor instance. Each sensor class can be given a name that is used in logs and warnings for clarity.
core_states_sptr_ = std::make_shared<mars::CoreState>();This line creates the core states. Core states are only instantiated once and are used to provide methods on how to operate on the core state throughout the framework.
core_states_sptr_.get()->set_propagation_sensor(imu_sensor_sptr_);At this point, the connection between the core states and the propagation sensor is made. This is used for e.g., the definition on how an incoming measurement is handled, and the information for the propagation process is routed accordingly.
// Sensors
pose1_sensor_sptr_ = std::make_shared<mars::PoseSensorClass>("Pose1", core_states_sptr_);
Eigen::Matrix<double, 6, 1> pose_meas_std;
pose_meas_std << 0.05, 0.05, 0.05, 3 * (M_PI / 180), 3 * (M_PI / 180), 3 * (M_PI / 180);
pose1_sensor_sptr_->R_ = pose_meas_std.cwiseProduct(pose_meas_std);These lines initialize a single sensor. First, similar to the IMU sensor instantiation, a shared pointer to the specific sensor object is created. Update sensors, compared to the propagation sensor, require the knowledge of the core state design. Thus, the shared pointer to the common core object needs to be provided for the sensor instantiation. Second, each sensor has a measurement noise field that depends on the state definition. Here, the values for the measurement noise are stored in pose1_sensor_sptr_->R_.
// Sensor Calibration
PoseSensorData pose_calibration;
pose_calibration.state_.p_ip_ = Eigen::Vector3d(0.0, 0.0, 0.0);
pose_calibration.state_.q_ip_ = Eigen::Quaterniond::Identity();
Eigen::Matrix<double, 6, 6> pose_cov;
pose_cov.setZero();
pose_cov.diagonal() << 0.0025, 0.0025, 0.0025, 0.0076, 0.0076, 0.0076; // 5cm, 5deg
pose_calibration.sensor_cov_ = pose_cov;
pose1_sensor_sptr_->set_initial_calib(std::make_shared<PoseSensorData>(pose_calibration));Each sensor, given that it has calibration states, has the option to initialize this calibration. Depending on the sensor module definition, the calibration states are automatically calibrated if sensor->set_initial_calib( ..) was not called.
The first lines instantiate a sensor state object that is set in consecutive lines. The second part of these lines generates the covariance matrix and map it to the state object. In the last line, the state object is passed to the sensor instance to set the calibration parameter.
// Sensor Chi2`
pose1_sensor_sptr_->chi2_.set_chi_value(0.05);
pose1_sensor_sptr_->chi2_.ActivateTest(true);Finally, a Chi2 test can be activated per sensor to perform a measurement validation and possible rejection at the update stage. These two options set the confidence value of the check and activate it. The Chi2-rejection test is deactivated by default.
The routine for the propagation of the navigation states through propagation sensor measurements is generally not different from the sensor update routine. However, this routine includes the initialization of the filter and is thus shown for completeness.
void MarsWrapperPose::ImuMeasurementCallback(const sensor_msgs::ImuConstPtr& meas)
{
// Map the measutement to the mars type
Time timestamp(meas->header.stamp.toSec());
// Generate a measurement data block
BufferDataType data;
data.set_sensor_data(std::make_shared<IMUMeasurementType>
(MarsMsgConv::ImuMsgToImuMeas(*meas)));
// Call process measurement
core_logic_.ProcessMeasurement(imu_sensor_sptr_, timestamp, data);
// Initialize the first time at which the propagation sensor occures
if (!core_logic_.core_is_initialized_)
{
core_logic_.Initialize(p_wi_init_, q_wi_init_);
}
if (publish_on_propagation_)
{
mars::BufferEntryType latest_state;
core_logic_.buffer_.get_latest_state(&latest_state);
mars::CoreStateType latest_core_state = static_cast<mars::CoreType*>
(latest_state.data_.core_.get())->state_;
pub_ext_core_state_.publish(MarsMsgConv::ExtCoreStateToMsg(
latest_state.timestamp_.get_seconds(), latest_core_state));
}
}// Map the measutement to the mars type
Time timestamp(meas->header.stamp.toSec());
// Generate a measurement data block
BufferDataType data;
data.set_sensor_data(std::make_shared<IMUMeasurementType>
(MarsMsgConv::ImuMsgToImuMeas(*meas)));In the first lines, the data types which may be specific to the middleware are mapped to internal MaRS types. This concerns the timestamp type and sensor measurement. For the ROS wrapper, the MaRS framework already provides conversions between ROS messages and various sensor measurement types. These are then mapped to the buffer data field.
// Call process measurement
core_logic_.ProcessMeasurement(imu_sensor_sptr_, timestamp, data);In the next step, this information is passed to the ProcessMeasurement routine. This routine requires the shared pointer to the individual sensor instance, the timestamp associated with the measurement, and the measurement in the form of a buffer element data type.
// Initialize the first time at which the propagation sensor occures
if (!core_logic_.core_is_initialized_)
{
core_logic_.Initialize(p_wi_init_, q_wi_init_);
}The ProcessMeasurement routine does not start the filtering process until the Initialize() member function is called. This function can be altered, but in the default case, it uses the latest pose information for the initialization.
mars::BufferEntryType latest_state;
core_logic_.buffer_.get_latest_state(&latest_state);
mars::CoreStateType latest_core_state = static_cast<mars::CoreType*>
(latest_state.data_.core_.get())->state_;The last segments cover the call for the latest data entries and their consecutive publishing. After calling the ProcessMeasurement() function, the buffer is up to date, and the latest entry contains the latest state. First, we instantiate a variable of the buffer entry type, which will receive the latest state in the next step with get_latest_state(). After this, we get the "state" element from the data field of the buffer. Since this is a void type, we need to cast it to the CoreType before usage. The buffer entry data type is described here
pub_ext_core_state_.publish(MarsMsgConv::ExtCoreStateToMsg(
latest_state.timestamp_.get_seconds(), latest_core_state));In the final step, we convert the state information to a ROS message and publish it accordingly.
void MarsWrapperPose::PoseMeasurementUpdate(
std::shared_ptr<mars::PoseSensorClass> sensor_sptr,
const PoseMeasurementType& pose_meas, const Time& timestamp)
{
// TMP feedback init pose
p_wi_init_ = pose_meas.position_;
q_wi_init_ = pose_meas.orientation_;
// Generate a measurement data block
BufferDataType data;
data.set_sensor_data(std::make_shared<PoseMeasurementType>(pose_meas));
// Call process measurement
if (!core_logic_.ProcessMeasurement(sensor_sptr, timestamp_corr, data))
{
return;
}
// Publish the latest sensor state
mars::BufferEntryType latest_result;
core_logic_.buffer_.get_latest_sensor_handle_state(
sensor_sptr, &latest_result);
mars::CoreStateType latest_core_state = static_cast<mars::CoreType*>
(latest_state.data_.core_.get())->state_;
pub_ext_core_state_.publish(MarsMsgConv::ExtCoreStateToMsg(
latest_state.timestamp_.get_seconds(), latest_core_state));
mars::PoseSensorStateType pose_sensor_state =
sensor_sptr.get()->get_state(latest_result.data_.sensor_);
pub_pose1_state_.publish(MarsMsgConv::PoseStateToPoseMsg(
latest_result.timestamp_.get_seconds(), pose_sensor_state));
}// TMP feedback init pose
p_wi_init_ = pose_meas.position_;
q_wi_init_ = pose_meas.orientation_;These lines depend on the specific usage of the filter, but in general, you need information on how to initialize the filter. In this case, we store the latest pose of a pose sensor and pass this to the core state initialization routine of the filter should be initialized.
// Generate a measurement data block
BufferDataType data;
data.set_sensor_data(std::make_shared<PoseMeasurementType>(pose_meas));At this point, we are simply mapping the sensor measurement, which is already provided as the sensor's measurement type.
// Call process measurement
if (!core_logic_.ProcessMeasurement(sensor_sptr, timestamp_corr, data))
{
return;
}Similar to the propagation routine, we pass the shared pointer to the specific sensor instance, the time stamp, and sensor measurement to the ProcessMeasurement function. The function returns true if the update was successful.
// Publish the latest sensor state
mars::BufferEntryType latest_result;
core_logic_.buffer_.get_latest_sensor_handle_state(
sensor_sptr, &latest_result);At this point, we get the latest core state and state of the sensor (if this sensor has calibration states defined). First, we generate a buffer entry, then get_latest_sensor_handle_state returns the latest state which was generated by the sensor, associated with the shared pointer sensor_sptr.
mars::CoreStateType latest_core_state = static_cast<mars::CoreType*>
(latest_state.data_.core_.get())->state_;
pub_ext_core_state_.publish(MarsMsgConv::ExtCoreStateToMsg(
latest_state.timestamp_.get_seconds(), latest_core_state));Here we use the buffer entry from the previous step and extract the core state information, which is part of the buffer entry data field. The core state MaRS data type is then converted to a ROS message and published.
mars::PoseSensorStateType pose_sensor_state =
sensor_sptr.get()->get_state(latest_result.data_.sensor_);
pub_pose1_state_.publish(MarsMsgConv::PoseStateToPoseMsg(
latest_result.timestamp_.get_seconds(), pose_sensor_state));These lines act in the same way as for the core state publishing described above. The only difference is that we are accessing the buffer data sensor field and convert the MaRS sensor data type to another ROS message type. Also, instead of casting the type by hand, the sensor class already provides a getter function to perform the case.
The definition of a sensor requires three essential files. These files should be placed in a dedicated folder.
Files to copy/generate in source/mars/include/mars/sensors/<your_sensor>:
- <your_sensor>_measurement_type.h
- <your_sensor>_sensor_state_type.h
- <your_sensor>_sensor_class.h
You can copy the files from the pose sensor module and use them as a template.
Steps:
- Define the data type for your sensor measurements in
<your_sensor>_measurement_type.h - Define the sensor state in
<your_sensor>_sensor_state_type.h - In
<your_sensor>_sensor_class.h:- Edit the data types to the definition from the two files above
- Edit the initialization routine
- Edit the measurement mapping
- Edit the definition of the Jacobian
- Edit the definition of the residual
- Edit the definition of the
ApplyCorrection(...)member function
Add the files to the CMakelist:
CMakeLists in source/mars/CMakeLists.txtAdd the sensor-files to:
set(headers
...
${include_path}/sensors/<your_sensor>/<your_sensor>_measurement_type.h
${include_path}/sensors/<your_sensor>/<your_sensor>_sensor_class.h
${include_path}/sensors/<your_sensor>/<your_sensor>_sensor_state_type.h
...
)If your sensor requires helper classes or have .cpp files, you need to add them to the following section:
set(sources
...
${include_path}/sensors/<your_sensor>
...
)After these steps have been completed, you can use the sensor as a generalized object in the MaRS framework.
Setup:
- Ublox GPS Receiver (8Hz)
- Pixhawk Autopilot IMU (200Hz)
- MaRS GNSS Pose-Estimation
- PX4 State-Estimation Bridge
- Clean and direct interface to our MARS estimator without chained EKF structures (e.g., via build-in PX4 EKF2)
- Link to the complete flight setup: AAU CNS Flight Package
- Member of
mars::BufferEntryTypeIsState()->HasStates() - Member of
BufferDataTypewithinmars::BufferEntryTypebuffer_entry.data_.core_->buffer_entry.data_.core_state_buffer_entry.data_.sensor_->buffer_entry.data_.sensor_state_- Measurement data is not indicated by meta data anymore and now has a dedicated member variable and setter:
data.set_sensor_data()->data.set_measurement()
BufferMetadataTypehas no type callesmeasurementanymore. It now indicates the validity of the state and remarks if a measurement was out of order. Passing this type can now be omitted e.g.:BufferEntryType gps_meas_entry(timestamp, data, gps1_sensor_sptr_, BufferMetadataType::measurement);->BufferEntryType gps_meas_entry(timestamp, data, gps1_sensor_sptr_);
- Process Noise: At the very moment, MaRS only supports the definition of dynamic process noise for the core states and not for sensor auxiliary/calibration states.
For further information, please contact Christian Brommer
This software is made available to the public to use (source-available), licensed under the terms of the BSD-2-Clause-License with no commercial use allowed, the full terms of which are made available in the LICENSE file. No license in patents is granted.
If you use this software in an academic research setting, please cite the corresponding paper and consult the LICENSE file for a detailed explanation.
@inproceedings{brommer2020,
author = {Brommer, Christian and Jung, Roland and Steinbrener, Jan and Weiss, Stephan},
doi = {10.1109/LRA.2020.3043195},
journal = {IEEE Robotics and Automation Letters},
title = {{MaRS : A Modular and Robust Sensor-Fusion Framework}},
year = {2020}
}