UnscentedKalmanFilter< SystemModelT > Class Template Reference

#include <RobotAPI/libraries/ukfm/UnscentedKalmanFilter.h>

Public Types

using AlphaT = Eigen::Matrix<FloatT, 3, 1>
 
using ControlNoiseT
 
using ControlT = typename SystemModelT::ControlT
 
using dim = typename SystemModelT::dim
 
using FloatT = typename SystemModelT::FloatT
 
using ObsCovT = Eigen::Matrix<FloatT, dim::obs, dim::obs>
 
using ObsT = Eigen::Matrix<FloatT, dim::obs, 1>
 
using PropCovT = Eigen::Matrix<FloatT, dim::control, dim::control>
 
using SigmaPointsT = typename SystemModelT::SigmaPointsT
 
using StateCovT = Eigen::Matrix<FloatT, dim::state, dim::state>
 
using StateT = typename SystemModelT::StateT
 

Public Member Functions

const StateTgetCurrentState () const
 
const StateCovTgetCurrentStateCovariance () const
 
void propagation (const ControlT &omega, FloatT dt)
 
 UnscentedKalmanFilter ()=delete
 
 UnscentedKalmanFilter (const PropCovT &Q, ObsCovT R, const AlphaT &alpha, StateT state0, StateCovT P0)
 
void update (const ObsT &y)
 

Static Public Attributes

static constexpr float eps = 10 * std::numeric_limits<float>::epsilon()
 

Detailed Description

template<typename SystemModelT>
class UnscentedKalmanFilter< SystemModelT >

Definition at line 36 of file UnscentedKalmanFilter.h.

Member Typedef Documentation

◆ AlphaT

template<typename SystemModelT>
using AlphaT = Eigen::Matrix<FloatT, 3, 1>

Definition at line 53 of file UnscentedKalmanFilter.h.

◆ ControlNoiseT

template<typename SystemModelT>
using ControlNoiseT
Initial value:
Eigen::Matrix< FloatT, dim::control, 1 > ControlNoiseT
Definition SystemModel.h:91

Definition at line 45 of file UnscentedKalmanFilter.h.

◆ ControlT

template<typename SystemModelT>
using ControlT = typename SystemModelT::ControlT

Definition at line 44 of file UnscentedKalmanFilter.h.

◆ dim

template<typename SystemModelT>
using dim = typename SystemModelT::dim

Definition at line 42 of file UnscentedKalmanFilter.h.

◆ FloatT

template<typename SystemModelT>
using FloatT = typename SystemModelT::FloatT

Definition at line 39 of file UnscentedKalmanFilter.h.

◆ ObsCovT

template<typename SystemModelT>
using ObsCovT = Eigen::Matrix<FloatT, dim::obs, dim::obs>

Definition at line 52 of file UnscentedKalmanFilter.h.

◆ ObsT

template<typename SystemModelT>
using ObsT = Eigen::Matrix<FloatT, dim::obs, 1>

Definition at line 51 of file UnscentedKalmanFilter.h.

◆ PropCovT

template<typename SystemModelT>
using PropCovT = Eigen::Matrix<FloatT, dim::control, dim::control>

Definition at line 50 of file UnscentedKalmanFilter.h.

◆ SigmaPointsT

template<typename SystemModelT>
using SigmaPointsT = typename SystemModelT::SigmaPointsT

Definition at line 47 of file UnscentedKalmanFilter.h.

◆ StateCovT

template<typename SystemModelT>
using StateCovT = Eigen::Matrix<FloatT, dim::state, dim::state>

Definition at line 49 of file UnscentedKalmanFilter.h.

◆ StateT

template<typename SystemModelT>
using StateT = typename SystemModelT::StateT

Definition at line 43 of file UnscentedKalmanFilter.h.

Constructor & Destructor Documentation

◆ UnscentedKalmanFilter() [1/2]

template<typename SystemModelT>
UnscentedKalmanFilter ( const PropCovT & Q,
ObsCovT R,
const AlphaT & alpha,
StateT state0,
StateCovT P0 )

Definition at line 36 of file UnscentedKalmanFilter.cpp.

◆ UnscentedKalmanFilter() [2/2]

template<typename SystemModelT>
UnscentedKalmanFilter ( )
delete

Member Function Documentation

◆ getCurrentState()

template<typename SystemModelT>
const UnscentedKalmanFilter< SystemModelT >::StateT & getCurrentState ( ) const

Definition at line 170 of file UnscentedKalmanFilter.cpp.

+ Here is the caller graph for this function:

◆ getCurrentStateCovariance()

template<typename SystemModelT>
const UnscentedKalmanFilter< SystemModelT >::StateCovT & getCurrentStateCovariance ( ) const

Definition at line 177 of file UnscentedKalmanFilter.cpp.

+ Here is the caller graph for this function:

◆ propagation()

template<typename SystemModelT>
void propagation ( const ControlT & omega,
FloatT dt )

Definition at line 53 of file UnscentedKalmanFilter.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ update()

template<typename SystemModelT>
void update ( const ObsT & y)

Definition at line 121 of file UnscentedKalmanFilter.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ eps

template<typename SystemModelT>
float eps = 10 * std::numeric_limits<float>::epsilon()
staticconstexpr

Definition at line 40 of file UnscentedKalmanFilter.h.


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