Main MRPT website > C++ reference for MRPT 1.5.6
List of all members | Public Member Functions | Public Attributes | Static Protected Member Functions
mrpt::maps::COctoMapBase< octree_t, octree_node_t >::TLikelihoodOptions Struct Reference

Detailed Description

template<class octree_t, class octree_node_t>
struct mrpt::maps::COctoMapBase< octree_t, octree_node_t >::TLikelihoodOptions

Options used when evaluating "computeObservationLikelihood".

See also
CObservation::computeObservationLikelihood

Definition at line 139 of file maps/COctoMapBase.h.

#include <mrpt/maps/COctoMapBase.h>

Inheritance diagram for mrpt::maps::COctoMapBase< octree_t, octree_node_t >::TLikelihoodOptions:
Inheritance graph

Public Member Functions

 TLikelihoodOptions ()
 Initilization of default parameters. More...
 
virtual ~TLikelihoodOptions ()
 
void loadFromConfigFile (const mrpt::utils::CConfigFileBase &source, 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 should clearly display all the contents of the structure in textual form, sending it to a CStream. More...
 
void writeToStream (mrpt::utils::CStream &out) const
 Binary dump to stream. More...
 
void readFromStream (mrpt::utils::CStream &in)
 Binary dump to stream. 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

uint32_t decimation
 Speed up the likelihood computation by considering only one out of N rays (default=1) 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

◆ TLikelihoodOptions()

template<class OCTREE , class OCTREE_NODE >
mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::TLikelihoodOptions ( )

Initilization of default parameters.

Definition at line 262 of file COctoMapBase_impl.h.

◆ ~TLikelihoodOptions()

template<class octree_t, class octree_node_t>
virtual mrpt::maps::COctoMapBase< octree_t, octree_node_t >::TLikelihoodOptions::~TLikelihoodOptions ( )
inlinevirtual

Definition at line 144 of file maps/COctoMapBase.h.

Member Function Documentation

◆ dumpToConsole()

void CLoadableOptions::dumpToConsole ( ) const
inherited

◆ dumpToTextStream()

template<class OCTREE , class OCTREE_NODE >
void mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::dumpToTextStream ( mrpt::utils::CStream out) const
virtual

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

The default implementation in this base class relies on saveToConfigFile() to generate a plain text representation of all the parameters.

Reimplemented from mrpt::utils::CLoadableOptions.

Definition at line 313 of file COctoMapBase_impl.h.

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

◆ dumpVar_bool()

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

◆ dumpVar_double()

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

◆ dumpVar_float()

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

◆ 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

◆ loadFromConfigFile()

template<class OCTREE , class OCTREE_NODE >
void mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::loadFromConfigFile ( const mrpt::utils::CConfigFileBase source,
const std::string section 
)
virtual

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 346 of file COctoMapBase_impl.h.

References MRPT_LOAD_CONFIG_VAR.

◆ 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().

◆ readFromStream()

template<class OCTREE , class OCTREE_NODE >
void mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::readFromStream ( mrpt::utils::CStream in)

Binary dump to stream.

Definition at line 276 of file COctoMapBase_impl.h.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and version.

◆ saveToConfigFile()

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

◆ 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().

◆ writeToStream()

template<class OCTREE , class OCTREE_NODE >
void mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::writeToStream ( mrpt::utils::CStream out) const

Binary dump to stream.

Definition at line 268 of file COctoMapBase_impl.h.

References version.

Member Data Documentation

◆ decimation

template<class octree_t, class octree_node_t>
uint32_t mrpt::maps::COctoMapBase< octree_t, octree_node_t >::TLikelihoodOptions::decimation

Speed up the likelihood computation by considering only one out of N rays (default=1)

Definition at line 152 of file maps/COctoMapBase.h.




Page generated by Doxygen 1.8.14 for MRPT 1.5.6 Git: 4c65e8431 Tue Apr 24 08:18:17 2018 +0200 at lun oct 28 01:35:26 CET 2019