diff --git a/mola_kernel/include/mola_kernel/interfaces/NavStateFilter.h b/mola_kernel/include/mola_kernel/interfaces/NavStateFilter.h index cb9ea00..7f65eab 100644 --- a/mola_kernel/include/mola_kernel/interfaces/NavStateFilter.h +++ b/mola_kernel/include/mola_kernel/interfaces/NavStateFilter.h @@ -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 #include #include #include @@ -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(); @@ -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 */