Detailed Description

Generic options for the Kalman Filter algorithm in itself.

Definition at line 53 of file CKalmanFilterCapable.h.

#include <mrpt/bayes/CKalmanFilterCapable.h>

Inheritance diagram for mrpt::bayes::TKF_options:

Public Member Functions
	TKF_options (mrpt::utils::VerbosityLevel &verb_level_ref)

void	loadFromConfigFile (const mrpt::utils::CConfigFileBase &iniFile, const std::string &section) MRPT_OVERRIDE
	This method load the options from a ".ini"-like file or memory-stored string list. More...

void	dumpToTextStream (mrpt::utils::CStream &out) const MRPT_OVERRIDE
	This method must display clearly all the contents of the structure in textual form, sending it to a CStream. More...

void	loadFromConfigFileName (const std::string &config_file, const std::string &section)
	Behaves like loadFromConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to load the file. More...

virtual void	saveToConfigFile (mrpt::utils::CConfigFileBase &target, const std::string &section) const
	This method saves the options to a ".ini"-like file or memory-stored string list. More...

void	saveToConfigFileName (const std::string &config_file, const std::string &section) const
	Behaves like saveToConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to save the file. More...

void	dumpToConsole () const
	Just like dumpToTextStream() but sending the text to the console (std::cout) More...

Public Attributes
TKFMethod	method
	The method to employ (default: kfEKFNaive) More...

mrpt::utils::VerbosityLevel &	verbosity_level

int	IKF_iterations
	Number of refinement iterations, only for the IKF method. More...

bool	enable_profiler
	If enabled (default=false), detailed timing information will be dumped to the console thru a CTimerLog at the end of the execution. More...

bool	use_analytic_transition_jacobian
	(default=true) If true, OnTransitionJacobian will be called; otherwise, the Jacobian will be estimated from a numeric approximation by calling several times to OnTransitionModel. More...

bool	use_analytic_observation_jacobian
	(default=true) If true, OnObservationJacobians will be called; otherwise, the Jacobian will be estimated from a numeric approximation by calling several times to OnObservationModel. More...

bool	debug_verify_analytic_jacobians
	(default=false) If true, will compute all the Jacobians numerically and compare them to the analytical ones, throwing an exception on mismatch. More...

double	debug_verify_analytic_jacobians_threshold
	(default-1e-2) Sets the threshold for the difference between the analytic and the numerical jacobians More...

Static Protected Member Functions
static void	dumpVar_int (CStream &out, const char *varName, int v)
	Used to print variable info from dumpToTextStream with the macro LOADABLEOPTS_DUMP_VAR. More...

static void	dumpVar_float (CStream &out, const char *varName, float v)

static void	dumpVar_double (CStream &out, const char *varName, double v)

static void	dumpVar_bool (CStream &out, const char *varName, bool v)

static void	dumpVar_string (CStream &out, const char *varName, const std::string &v)

Constructor & Destructor Documentation

◆ TKF_options()

mrpt::bayes::TKF_options::TKF_options ( mrpt::utils::VerbosityLevel & verb_level_ref )

inline

Definition at line 55 of file CKalmanFilterCapable.h.

Member Function Documentation

◆ dumpToConsole()

void CLoadableOptions::dumpToConsole ( ) const

inherited

Just like dumpToTextStream() but sending the text to the console (std::cout)

Definition at line 47 of file CLoadableOptions.cpp.

References mrpt::utils::CLoadableOptions::dumpToTextStream(), and loadable_opts_my_cout.

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), mrpt::hmtslam::CHMTSLAM::loadOptions(), and mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::printParams().

◆ dumpToTextStream()

void mrpt::bayes::TKF_options::dumpToTextStream ( mrpt::utils::CStream & out ) const

inlinevirtual

This method must display clearly all the contents of the structure in textual form, sending it to a CStream.

Reimplemented from mrpt::utils::CLoadableOptions.

Definition at line 80 of file CKalmanFilterCapable.h.

References enable_profiler, IKF_iterations, method, and verbosity_level.

◆ dumpVar_bool()

void CLoadableOptions::dumpVar_bool	(	CStream &	out,
		const char *	varName,
		bool	v
	)

staticprotectedinherited

Definition at line 67 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ dumpVar_double()

void CLoadableOptions::dumpVar_double	(	CStream &	out,
		const char *	varName,
		double	v
	)

staticprotectedinherited

Definition at line 62 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ dumpVar_float()

void CLoadableOptions::dumpVar_float	(	CStream &	out,
		const char *	varName,
		float	v
	)

staticprotectedinherited

Definition at line 57 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ dumpVar_int()

void CLoadableOptions::dumpVar_int	(	CStream &	out,
		const char *	varName,
		int	v
	)

staticprotectedinherited

Used to print variable info from dumpToTextStream with the macro LOADABLEOPTS_DUMP_VAR.

Definition at line 52 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ dumpVar_string()

void CLoadableOptions::dumpVar_string	(	CStream &	out,
		const char *	varName,
		const std::string &	v
	)

staticprotectedinherited

Definition at line 72 of file CLoadableOptions.cpp.

References LOADABLEOPTS_COLUMN_WIDTH, and mrpt::utils::CStream::printf().

◆ loadFromConfigFile()

void mrpt::bayes::TKF_options::loadFromConfigFile	(	const mrpt::utils::CConfigFileBase &	source,
		const std::string &	section
	)

inlinevirtual

This method load the options from a ".ini"-like file or memory-stored string list.

Only those parameters found in the given "section" and having the same name that the variable are loaded. Those not found in the file will stay with their previous values (usually the default values loaded at initialization). An example of an ".ini" file:

[section]
resolution    = 0.10   // blah blah...
modeSelection = 1      // 0=blah, 1=blah,...

See also: loadFromConfigFileName, saveToConfigFile

Implements mrpt::utils::CLoadableOptions.

Definition at line 67 of file CKalmanFilterCapable.h.

References debug_verify_analytic_jacobians, debug_verify_analytic_jacobians_threshold, enable_profiler, IKF_iterations, method, MRPT_LOAD_CONFIG_VAR, use_analytic_observation_jacobian, use_analytic_transition_jacobian, and verbosity_level.

Referenced by mrpt::slam::CRangeBearingKFSLAM2D::loadOptions(), and mrpt::slam::CRangeBearingKFSLAM::loadOptions().

◆ loadFromConfigFileName()

void CLoadableOptions::loadFromConfigFileName	(	const std::string &	config_file,
		const std::string &	section
	)

inherited

Behaves like loadFromConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to load the file.

See also: loadFromConfigFile

Definition at line 23 of file CLoadableOptions.cpp.

References mrpt::utils::CLoadableOptions::loadFromConfigFile().

Referenced by mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::loadParams().

◆ saveToConfigFile()

void CLoadableOptions::saveToConfigFile	(	mrpt::utils::CConfigFileBase &	target,
		const std::string &	section
	)		const

virtualinherited

This method saves the options to a ".ini"-like file or memory-stored string list.

See also: loadFromConfigFile, saveToConfigFileName

Reimplemented in mrpt::vision::TMultiResDescOptions, mrpt::vision::TMultiResDescMatchOptions, mrpt::nav::CPTG_RobotShape_Circular, mrpt::nav::CPTG_RobotShape_Polygonal, mrpt::nav::CParameterizedTrajectoryGenerator, mrpt::nav::CAbstractPTGBasedReactive::TAbstractPTGNavigatorParams, mrpt::nav::CAbstractNavigator::TAbstractNavigatorParams, mrpt::nav::CPTG_DiffDrive_CollisionGridBased, mrpt::nav::CHolonomicND::TOptions, mrpt::nav::CWaypointsNavigator::TWaypointsNavigatorParams, mrpt::nav::CHolonomicFullEval::TOptions, mrpt::nav::CReactiveNavigationSystem::TReactiveNavigatorParams, mrpt::nav::CHolonomicVFF::TOptions, mrpt::nav::CMultiObjectiveMotionOptimizerBase::TParamsBase, mrpt::maps::CPointCloudFilterByDistance::TOptions, mrpt::nav::CPTG_DiffDrive_C, mrpt::nav::CPTG_DiffDrive_alpha, mrpt::nav::CMultiObjMotionOpt_Scalarization::TParams, mrpt::nav::CPTG_DiffDrive_CC, mrpt::nav::CPTG_DiffDrive_CCS, mrpt::nav::CPTG_DiffDrive_CS, and mrpt::nav::CPTG_Holo_Blend.

Definition at line 31 of file CLoadableOptions.cpp.

References MRPT_UNUSED_PARAM.

Referenced by mrpt::utils::CLoadableOptions::dumpToTextStream(), and mrpt::utils::CLoadableOptions::saveToConfigFileName().

◆ saveToConfigFileName()

void CLoadableOptions::saveToConfigFileName	(	const std::string &	config_file,
		const std::string &	section
	)		const

inherited

Behaves like saveToConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to save the file.

See also: saveToConfigFile, loadFromConfigFileName

Definition at line 39 of file CLoadableOptions.cpp.

References mrpt::utils::CLoadableOptions::saveToConfigFile().

Member Data Documentation

◆ debug_verify_analytic_jacobians

bool mrpt::bayes::TKF_options::debug_verify_analytic_jacobians

(default=false) If true, will compute all the Jacobians numerically and compare them to the analytical ones, throwing an exception on mismatch.

Definition at line 97 of file CKalmanFilterCapable.h.

Referenced by loadFromConfigFile().

◆ debug_verify_analytic_jacobians_threshold

double mrpt::bayes::TKF_options::debug_verify_analytic_jacobians_threshold

(default-1e-2) Sets the threshold for the difference between the analytic and the numerical jacobians

Definition at line 98 of file CKalmanFilterCapable.h.

Referenced by loadFromConfigFile().

◆ enable_profiler

bool mrpt::bayes::TKF_options::enable_profiler

If enabled (default=false), detailed timing information will be dumped to the console thru a CTimerLog at the end of the execution.

Definition at line 94 of file CKalmanFilterCapable.h.

Referenced by dumpToTextStream(), and loadFromConfigFile().

◆ IKF_iterations

int mrpt::bayes::TKF_options::IKF_iterations

Number of refinement iterations, only for the IKF method.

Definition at line 93 of file CKalmanFilterCapable.h.

Referenced by dumpToTextStream(), and loadFromConfigFile().

◆ method

TKFMethod mrpt::bayes::TKF_options::method

The method to employ (default: kfEKFNaive)

Definition at line 91 of file CKalmanFilterCapable.h.

Referenced by dumpToTextStream(), and loadFromConfigFile().

◆ use_analytic_observation_jacobian

bool mrpt::bayes::TKF_options::use_analytic_observation_jacobian

(default=true) If true, OnObservationJacobians will be called; otherwise, the Jacobian will be estimated from a numeric approximation by calling several times to OnObservationModel.

Definition at line 96 of file CKalmanFilterCapable.h.

Referenced by loadFromConfigFile().

◆ use_analytic_transition_jacobian

bool mrpt::bayes::TKF_options::use_analytic_transition_jacobian

(default=true) If true, OnTransitionJacobian will be called; otherwise, the Jacobian will be estimated from a numeric approximation by calling several times to OnTransitionModel.

Definition at line 95 of file CKalmanFilterCapable.h.

Referenced by loadFromConfigFile().

◆ verbosity_level

mrpt::utils::VerbosityLevel& mrpt::bayes::TKF_options::verbosity_level

Definition at line 92 of file CKalmanFilterCapable.h.

Referenced by dumpToTextStream(), and loadFromConfigFile().

Detailed Description

Public Member Functions

Public Attributes

Static Protected Member Functions

Constructor & Destructor Documentation

◆ TKF_options()

Member Function Documentation

◆ dumpToConsole()

◆ dumpToTextStream()

◆ dumpVar_bool()

◆ dumpVar_double()

◆ dumpVar_float()

◆ dumpVar_int()

◆ dumpVar_string()

◆ loadFromConfigFile()

◆ loadFromConfigFileName()

◆ saveToConfigFile()

◆ saveToConfigFileName()

Member Data Documentation

◆ debug_verify_analytic_jacobians

◆ debug_verify_analytic_jacobians_threshold

◆ enable_profiler

◆ IKF_iterations

◆ method

◆ use_analytic_observation_jacobian

◆ use_analytic_transition_jacobian

◆ verbosity_level