Skip to content

Commit

Permalink
NavStateFilter Interface now also inherits from ExecutableBase for co…
Browse files Browse the repository at this point in the history
…nvenience
  • Loading branch information
jlblancoc committed Dec 26, 2024
1 parent 4b261db commit f0fbf5f
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions mola_kernel/include/mola_kernel/interfaces/NavStateFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
* ------------------------------------------------------------------------- */
/**
* @file NavStateFilter.h
* @brief Virtual base class for algorithms to fuse odometry, twist, IMU, etc.
* @brief Virtual base class for navigation state estimation algorithms.
* @author Jose Luis Blanco Claraco
* @date Jan 22, 2024
*/
#pragma once

#include <mola_kernel/interfaces/ExecutableBase.h>
#include <mrpt/containers/yaml.h>
#include <mrpt/core/Clock.h>
#include <mrpt/math/TTwist3D.h>
Expand Down Expand Up @@ -49,11 +50,14 @@ struct NavState
std::string asString() const;
};

/** Unified API for kinematic state filtering algorithms,
* fusing information from multiple odometry or twist sources.
/** Virtual API for kinematic state filtering algorithms,
* fusing information from multiple odometry or twist sources, IMU, GNSS, etc.
*
* Refer to the "state estimation section"
* in [the docs](https://docs.mola-slam.org/)
*
* \ingroup mola_kernel_interfaces_grp */
class NavStateFilter : public mrpt::system::COutputLogger
class NavStateFilter : public mola::ExecutableBase
{
public:
NavStateFilter();
Expand All @@ -62,11 +66,8 @@ class NavStateFilter : public mrpt::system::COutputLogger
/** Resets the estimator state to an initial state */
virtual void reset() = 0;

/**
* @brief Initializes the object and reads all parameters from a YAML node.
* @param cfg a YAML node with a dictionary of parameters to load from.
*/
virtual void initialize(const mrpt::containers::yaml& cfg) = 0;
// initialize(): inherited from ExecutableBase. Must be implemented to load
// parameters, etc.

/** Integrates new SE(3) pose estimation of the vehicle wrt frame_id
*/
Expand Down

0 comments on commit f0fbf5f

Please sign in to comment.