This class represent a generic measurement model f(x, w), where x is a state vector and w is random noise. More...

#include <MeasurementModel.h>

Inheritance diagram for bfl::MeasurementModel:

Public Member Functions
virtual	~MeasurementModel () noexcept=default

virtual bool	freeze (const Data &data=Data())=0

virtual std::pair< bool, Data >	measure (const Data &data=Data()) const =0

virtual std::pair< bool, Data >	predictedMeasure (const Eigen::Ref< const Eigen::MatrixXd > &cur_states) const =0

virtual std::pair< bool, Data >	innovation (const Data &predicted_measurements, const Data &measurements) const =0

virtual std::pair< bool, Eigen::MatrixXd >	getNoiseCovarianceMatrix () const

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

virtual VectorDescription	getInputDescription () const

virtual VectorDescription	getMeasurementDescription () const

bool	enable_log (const std::string &folder_path, const std::string &file_name_prefix)

bool	disable_log ()

std::string	get_folder_path () const

std::string	get_file_name_prefix () const

template<typename DatumType >
void	logger (DatumType datum)

template<typename... DataType>
void	logger (DataType... data)

template<typename DatumType >
void	logger (DatumType datum) const

template<typename... DataType>
void	logger (DataType... data) const

Protected Member Functions
virtual std::vector< std::string >	log_file_names (const std::string &folder_path, const std::string &file_name_prefix)

virtual void	log ()

Private Member Functions
template<typename DatumType >
void	logger_helper (const size_t pos, DatumType datum)

template<typename DatumType , typename... DataType>
void	logger_helper (const size_t pos, DatumType datum, DataType... data)

template<typename DatumType >
void	logger_helper (const size_t pos, DatumType datum) const

template<typename DatumType , typename... DataType>
void	logger_helper (const size_t pos, DatumType datum, DataType... data) const

Private Attributes
std::string	folder_path_

std::string	file_name_prefix_

std::vector< std::string >	file_names_

bool	log_enabled_ = false

std::vector< std::ofstream >	log_files_

Detailed Description

This class represent a generic measurement model f(x, w), where x is a state vector and w is random noise.

Definition at line 29 of file MeasurementModel.h.

Constructor & Destructor Documentation

◆ ~MeasurementModel()

virtual bfl::MeasurementModel::~MeasurementModel ( )

virtualdefaultnoexcept

Member Function Documentation

◆ disable_log()

bool Logger::disable_log ( )

inherited

Definition at line 68 of file Logger.cpp.

References bfl::Logger::file_names_, bfl::Logger::log_enabled_, and bfl::Logger::log_files_.

Referenced by bfl::Logger::~Logger().

◆ enable_log()

bool Logger::enable_log	(	const std::string &	folder_path,
		const std::string &	file_name_prefix
	)

inherited

Definition at line 22 of file Logger.cpp.

References bfl::Logger::file_name_prefix_, bfl::Logger::file_names_, bfl::Logger::folder_path_, bfl::Logger::log_enabled_, bfl::Logger::log_file_names(), and bfl::Logger::log_files_.

Here is the call graph for this function:

◆ freeze()

virtual bool bfl::MeasurementModel::freeze ( const Data & data = Data() )

pure virtual

Implemented in bfl::MeasurementModelDecorator, and bfl::SimulatedLinearSensor.

◆ get_file_name_prefix()

std::string Logger::get_file_name_prefix ( ) const

inherited

Definition at line 91 of file Logger.cpp.

References bfl::Logger::file_name_prefix_.

◆ get_folder_path()

std::string Logger::get_folder_path ( ) const

inherited

Definition at line 85 of file Logger.cpp.

References bfl::Logger::folder_path_.

◆ getInputDescription()

VectorDescription MeasurementModel::getInputDescription ( ) const

virtual

Reimplemented in bfl::SimulatedLinearSensor.

Definition at line 30 of file MeasurementModel.cpp.

◆ getMeasurementDescription()

VectorDescription MeasurementModel::getMeasurementDescription ( ) const

virtual

Reimplemented in bfl::SimulatedLinearSensor.

Definition at line 37 of file MeasurementModel.cpp.

Referenced by bfl::UKFCorrection::correctStep(), and bfl::sigma_point::unscented_transform().

◆ getNoiseCovarianceMatrix()

std::pair< bool, MatrixXd > MeasurementModel::getNoiseCovarianceMatrix ( ) const

virtual

Reimplemented in bfl::LinearModel, bfl::LTIMeasurementModel, and bfl::MeasurementModelDecorator.

Definition at line 16 of file MeasurementModel.cpp.

Referenced by bfl::UKFCorrection::correctStep(), bfl::GaussianLikelihood::likelihood(), and bfl::sigma_point::unscented_transform().

◆ innovation()

virtual std::pair<bool, Data> bfl::MeasurementModel::innovation	(	const Data &	predicted_measurements,
		const Data &	measurements
	)		const

pure virtual

Implemented in bfl::LinearMeasurementModel, and bfl::MeasurementModelDecorator.

Referenced by bfl::UKFCorrection::correctStep(), and bfl::GaussianLikelihood::likelihood().

◆ log()

void Logger::log ( )

protectedvirtualinherited

Reimplemented in bfl::SimulatedStateModel, bfl::SIS, and bfl::SimulatedLinearSensor.

Definition at line 109 of file Logger.cpp.

◆ log_file_names()

std::vector< std::string > Logger::log_file_names	(	const std::string &	folder_path,
		const std::string &	file_name_prefix
	)

protectedvirtualinherited

Reimplemented in bfl::LinearModel, bfl::SimulatedStateModel, and bfl::SIS.

Definition at line 97 of file Logger.cpp.

Referenced by bfl::Logger::enable_log().

◆ logger() [1/4]

template<typename... DataType>

void bfl::Logger::logger ( DataType... data )

inlineinherited

Definition at line 42 of file Logger.h.

References bfl::Logger::log_enabled_, and bfl::Logger::logger_helper().

Here is the call graph for this function:

◆ logger() [2/4]

template<typename... DataType>

void bfl::Logger::logger ( DataType... data ) const

inlineinherited

Definition at line 56 of file Logger.h.

References bfl::Logger::log_enabled_, and bfl::Logger::logger_helper().

Here is the call graph for this function:

◆ logger() [3/4]

template<typename DatumType >

void bfl::Logger::logger ( DatumType datum )

inlineinherited

Definition at line 35 of file Logger.h.

References bfl::Logger::log_enabled_, and bfl::Logger::log_files_.

Referenced by bfl::SimulatedLinearSensor::log().

◆ logger() [4/4]

template<typename DatumType >

void bfl::Logger::logger ( DatumType datum ) const

inlineinherited

Definition at line 49 of file Logger.h.

References bfl::Logger::log_enabled_, and bfl::Logger::log_files_.

◆ logger_helper() [1/4]

template<typename DatumType >

void bfl::Logger::logger_helper	(	const size_t	pos,
		DatumType	datum
	)

inlineprivateinherited

Definition at line 81 of file Logger.h.

References bfl::Logger::log_files_.

Referenced by bfl::Logger::logger(), and bfl::Logger::logger_helper().

◆ logger_helper() [2/4]

template<typename DatumType >

void bfl::Logger::logger_helper	(	const size_t	pos,
		DatumType	datum
	)		const

inlineprivateinherited

Definition at line 95 of file Logger.h.

References bfl::Logger::log_files_.

◆ logger_helper() [3/4]

template<typename DatumType , typename... DataType>

void bfl::Logger::logger_helper	(	const size_t	pos,
		DatumType	datum,
		DataType...	data
	)

inlineprivateinherited

Definition at line 87 of file Logger.h.

References bfl::Logger::log_files_, and bfl::Logger::logger_helper().

Here is the call graph for this function:

◆ logger_helper() [4/4]

template<typename DatumType , typename... DataType>

void bfl::Logger::logger_helper	(	const size_t	pos,
		DatumType	datum,
		DataType...	data
	)		const

inlineprivateinherited

Definition at line 101 of file Logger.h.

References bfl::Logger::log_files_, and bfl::Logger::logger_helper().

Here is the call graph for this function:

◆ measure()

virtual std::pair<bool, Data> bfl::MeasurementModel::measure ( const Data & data = Data() ) const

pure virtual

Implemented in bfl::SimulatedLinearSensor, and bfl::MeasurementModelDecorator.

Referenced by bfl::UKFCorrection::correctStep(), and bfl::GaussianLikelihood::likelihood().

◆ predictedMeasure()

virtual std::pair<bool, Data> bfl::MeasurementModel::predictedMeasure ( const Eigen::Ref< const Eigen::MatrixXd > & cur_states ) const

pure virtual

Implemented in bfl::LinearMeasurementModel, and bfl::MeasurementModelDecorator.

Referenced by bfl::GaussianLikelihood::likelihood(), and bfl::sigma_point::unscented_transform().

◆ setProperty()

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

virtual

Reimplemented in bfl::MeasurementModelDecorator.

Definition at line 22 of file MeasurementModel.cpp.

Member Data Documentation

◆ file_name_prefix_

std::string bfl::Logger::file_name_prefix_

privateinherited

Definition at line 72 of file Logger.h.

Referenced by bfl::Logger::enable_log(), and bfl::Logger::get_file_name_prefix().

◆ file_names_

std::vector<std::string> bfl::Logger::file_names_

privateinherited

Definition at line 74 of file Logger.h.

Referenced by bfl::Logger::disable_log(), and bfl::Logger::enable_log().

◆ folder_path_

std::string bfl::Logger::folder_path_

privateinherited

Definition at line 70 of file Logger.h.

Referenced by bfl::Logger::enable_log(), and bfl::Logger::get_folder_path().

◆ log_enabled_

bool bfl::Logger::log_enabled_ = false

privateinherited

Definition at line 76 of file Logger.h.

Referenced by bfl::Logger::disable_log(), bfl::Logger::enable_log(), bfl::Logger::logger(), and bfl::Logger::~Logger().

◆ log_files_

std::vector<std::ofstream> bfl::Logger::log_files_

mutableprivateinherited

Definition at line 78 of file Logger.h.

Referenced by bfl::Logger::disable_log(), bfl::Logger::enable_log(), bfl::Logger::logger(), and bfl::Logger::logger_helper().

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

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~MeasurementModel()

Member Function Documentation

◆ disable_log()

◆ enable_log()

◆ freeze()

◆ get_file_name_prefix()

◆ get_folder_path()

◆ getInputDescription()

◆ getMeasurementDescription()

◆ getNoiseCovarianceMatrix()

◆ innovation()

◆ log()

◆ log_file_names()

◆ logger() [1/4]

◆ logger() [2/4]

◆ logger() [3/4]

◆ logger() [4/4]

◆ logger_helper() [1/4]

◆ logger_helper() [2/4]

◆ logger_helper() [3/4]

◆ logger_helper() [4/4]

◆ measure()

◆ predictedMeasure()

◆ setProperty()

Member Data Documentation

◆ file_name_prefix_

◆ file_names_

◆ folder_path_

◆ log_enabled_

◆ log_files_