#include <LTIStateModel.h>

Inheritance diagram for bfl::LTIStateModel:

Public Member Functions
	LTIStateModel (const Eigen::Ref< const Eigen::MatrixXd > &transition_matrix, const Eigen::Ref< const Eigen::MatrixXd > &noise_covariance_matrix)

	LTIStateModel (const LTIStateModel &state_model) noexcept=delete

LTIStateModel &	operator= (const LTIStateModel &state_model) noexcept=delete

	LTIStateModel (LTIStateModel &&state_model) noexcept

LTIStateModel &	operator= (LTIStateModel &&state_model) noexcept

virtual	~LTIStateModel () noexcept=default

bool	setProperty (const std::string &property) override

Eigen::MatrixXd	getJacobian () override

Eigen::MatrixXd	getNoiseCovarianceMatrix () override

Eigen::MatrixXd	getStateTransitionMatrix () override

virtual void	propagate (const Eigen::Ref< const Eigen::MatrixXd > &cur_states, Eigen::Ref< Eigen::MatrixXd > prop_states) override

virtual void	motion (const Eigen::Ref< const Eigen::MatrixXd > &cur_states, Eigen::Ref< Eigen::MatrixXd > mot_states) override

virtual VectorDescription	getInputDescription ()
	Returns the vector description of the input to the state equation. More...

bool	skip (const std::string &what_step, const bool status) override

bool	is_skipping () override

bool	add_exogenous_model (std::unique_ptr< ExogenousModel > exogenous_model)

bool	have_exogenous_model () noexcept

ExogenousModel &	exogenous_model ()

virtual Eigen::VectorXd	getTransitionProbability (const Eigen::Ref< const Eigen::MatrixXd > &prev_states, const Eigen::Ref< const Eigen::MatrixXd > &cur_states)

virtual Eigen::MatrixXd	getNoiseSample (const std::size_t num)

virtual bool	setSamplingTime (const double &time)

virtual VectorDescription	getStateDescription ()=0
	Returns the vector description of the output of the state equation. More...

Private Attributes
Eigen::MatrixXd	F_
	State transition matrix. More...

Eigen::MatrixXd	Q_
	Noise covariance matrix of a zero mean additive white noise. More...

bool	skip_ = false
	Skip status. More...

std::unique_ptr< ExogenousModel >	exogenous_model_
	Exogenous model. More...

Detailed Description

Definition at line 18 of file LTIStateModel.h.

Constructor & Destructor Documentation

◆ LTIStateModel() [1/3]

bfl::LTIStateModel::LTIStateModel	(	const Eigen::Ref< const Eigen::MatrixXd > &	transition_matrix,
		const Eigen::Ref< const Eigen::MatrixXd > &	noise_covariance_matrix
	)

◆ LTIStateModel() [2/3]

bfl::LTIStateModel::LTIStateModel ( const LTIStateModel & state_model )

deletenoexcept

◆ LTIStateModel() [3/3]

LTIStateModel::LTIStateModel ( LTIStateModel && state_model )

noexcept

Definition at line 31 of file LTIStateModel.cpp.

◆ ~LTIStateModel()

virtual bfl::LTIStateModel::~LTIStateModel ( )

virtualdefaultnoexcept

Member Function Documentation

◆ add_exogenous_model()

bool StateModel::add_exogenous_model ( std::unique_ptr< ExogenousModel > exogenous_model )

inherited

Definition at line 33 of file StateModel.cpp.

◆ exogenous_model()

ExogenousModel & StateModel::exogenous_model ( )

inherited

Definition at line 50 of file StateModel.cpp.

◆ getInputDescription()

VectorDescription AdditiveStateModel::getInputDescription ( )

virtualinherited

Returns the vector description of the input to the state equation.

Implements bfl::StateProcess.

Definition at line 22 of file AdditiveStateModel.cpp.

References bfl::VectorDescription::add_noise_components().

Here is the call graph for this function:

◆ getJacobian()

MatrixXd LTIStateModel::getJacobian ( )

overridevirtual

Reimplemented from bfl::StateModel.

Definition at line 68 of file LTIStateModel.cpp.

References F_.

◆ getNoiseCovarianceMatrix()

MatrixXd LTIStateModel::getNoiseCovarianceMatrix ( )

overridevirtual

Reimplemented from bfl::StateModel.

Definition at line 56 of file LTIStateModel.cpp.

References Q_.

◆ getNoiseSample()

Eigen::MatrixXd StateModel::getNoiseSample ( const std::size_t num )

virtualinherited

Reimplemented in bfl::WhiteNoiseAcceleration.

Definition at line 78 of file StateModel.cpp.

◆ getStateDescription()

virtual VectorDescription bfl::StateProcess::getStateDescription ( )

pure virtualinherited

Returns the vector description of the output of the state equation.

Implemented in bfl::WhiteNoiseAcceleration.

Referenced by bfl::sigma_point::unscented_transform().

◆ getStateTransitionMatrix()

MatrixXd LTIStateModel::getStateTransitionMatrix ( )

overridevirtual

Implements bfl::LinearStateModel.

Definition at line 62 of file LTIStateModel.cpp.

References F_.

◆ getTransitionProbability()

Eigen::VectorXd StateModel::getTransitionProbability	(	const Eigen::Ref< const Eigen::MatrixXd > &	prev_states,
		const Eigen::Ref< const Eigen::MatrixXd > &	cur_states
	)

virtualinherited

Reimplemented in bfl::WhiteNoiseAcceleration.

Definition at line 66 of file StateModel.cpp.

◆ have_exogenous_model()

bool StateModel::have_exogenous_model ( )

noexceptinherited

Definition at line 41 of file StateModel.cpp.

◆ is_skipping()

bool StateModel::is_skipping ( )

overridevirtualinherited

Implements bfl::Skippable.

Definition at line 27 of file StateModel.cpp.

◆ motion()

void AdditiveStateModel::motion	(	const Eigen::Ref< const Eigen::MatrixXd > &	cur_states,
		Eigen::Ref< Eigen::MatrixXd >	mot_states
	)

overridevirtualinherited

Implements bfl::StateProcess.

Definition at line 14 of file AdditiveStateModel.cpp.

◆ operator=() [1/2]

LTIStateModel& bfl::LTIStateModel::operator= ( const LTIStateModel & state_model )

deletenoexcept

◆ operator=() [2/2]

LTIStateModel & LTIStateModel::operator= ( LTIStateModel && state_model )

noexcept

Definition at line 37 of file LTIStateModel.cpp.

◆ propagate()

void LinearStateModel::propagate	(	const Eigen::Ref< const Eigen::MatrixXd > &	cur_states,
		Eigen::Ref< Eigen::MatrixXd >	prop_states
	)

overridevirtualinherited

Implements bfl::StateProcess.

Definition at line 16 of file LinearStateModel.cpp.

◆ setProperty()

bool LTIStateModel::setProperty ( const std::string & property )

overridevirtual

Implements bfl::StateProcess.

Definition at line 50 of file LTIStateModel.cpp.

◆ setSamplingTime()

bool StateModel::setSamplingTime ( const double & time )

virtualinherited

Definition at line 84 of file StateModel.cpp.

◆ skip()

bool StateModel::skip	(	const std::string &	what_step,
		const bool	status
	)

overridevirtualinherited

Implements bfl::Skipper.

Definition at line 14 of file StateModel.cpp.

Member Data Documentation

◆ exogenous_model_

std::unique_ptr<ExogenousModel> bfl::StateModel::exogenous_model_

privateinherited

Exogenous model.

Definition at line 68 of file StateModel.h.

◆ F_

Eigen::MatrixXd bfl::LTIStateModel::F_

private

State transition matrix.

Definition at line 45 of file LTIStateModel.h.

Referenced by getJacobian(), and getStateTransitionMatrix().

◆ Q_

Eigen::MatrixXd bfl::LTIStateModel::Q_

private

Noise covariance matrix of a zero mean additive white noise.

Definition at line 50 of file LTIStateModel.h.

Referenced by getNoiseCovarianceMatrix().

◆ skip_

bool bfl::StateModel::skip_ = false

privateinherited

Skip status.

Definition at line 63 of file StateModel.h.

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

/home/user/bayes-filters-lib/src/BayesFilters/include/BayesFilters/LTIStateModel.h
/home/user/bayes-filters-lib/src/BayesFilters/src/LTIStateModel.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LTIStateModel() [1/3]

◆ LTIStateModel() [2/3]

◆ LTIStateModel() [3/3]

◆ ~LTIStateModel()

Member Function Documentation

◆ add_exogenous_model()

◆ exogenous_model()

◆ getInputDescription()

◆ getJacobian()

◆ getNoiseCovarianceMatrix()

◆ getNoiseSample()

◆ getStateDescription()

◆ getStateTransitionMatrix()

◆ getTransitionProbability()

◆ have_exogenous_model()

◆ is_skipping()

◆ motion()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ propagate()

◆ setProperty()

◆ setSamplingTime()

◆ skip()

Member Data Documentation

◆ exogenous_model_

◆ F_

◆ Q_

◆ skip_