mrpt::slam::CColouredPointsMap::TColourOptions Struct Reference

---

Detailed Description

The definition of parameters for generating colors from laser scans.

#include <mrpt/slam/CColouredPointsMap.h>

Inheritance diagram for mrpt::slam::CColouredPointsMap::TColourOptions:

List of all members.

Public Member Functions
	TColourOptions ()
	Initilization of default parameters.
virtual	~TColourOptions ()
void	loadFromConfigFile (const mrpt::utils::CConfigFileBase &source, const std::string &section)
	See utils::CLoadableOptions.
void	dumpToTextStream (CStream &out) const
	See utils::CLoadableOptions.
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.
virtual void	saveToConfigFile (mrpt::utils::CConfigFileBase &source, const std::string &section)
	This method saves the options to a ".ini"-like file or memory-stored string list.
void	saveToConfigFileName (const std::string &config_file, const std::string &section)
	Behaves like saveToConfigFile, but you can pass directly a file name and a temporary CConfigFile object will be created automatically to save the file.
void	dumpToConsole () const
	This method must display clearly all the contents of the structure in textual form, sending it to a CStream.
Public Attributes
TColouringMethod	scheme
float	z_min
float	z_max
float	d_max
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.
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

mrpt::slam::CColouredPointsMap::TColourOptions::TColourOptions

(

)

Initilization of default parameters.

virtual mrpt::slam::CColouredPointsMap::TColourOptions::~TColourOptions

(

)

[inline, virtual]

Definition at line 235 of file CColouredPointsMap.h.

---

Member Function Documentation

void mrpt::utils::CLoadableOptions::dumpToConsole

(

)

const [inherited]

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

void mrpt::slam::CColouredPointsMap::TColourOptions::dumpToTextStream

(

CStream &

out

)

const [virtual]

See utils::CLoadableOptions.

Implements mrpt::utils::CLoadableOptions.

static void mrpt::utils::CLoadableOptions::dumpVar_bool	(	CStream &	out,
		const char *	varName,
		bool	v
	)		[static, protected, inherited]

static void mrpt::utils::CLoadableOptions::dumpVar_double	(	CStream &	out,
		const char *	varName,
		double	v
	)		[static, protected, inherited]

static void mrpt::utils::CLoadableOptions::dumpVar_float	(	CStream &	out,
		const char *	varName,
		float	v
	)		[static, protected, inherited]

static void mrpt::utils::CLoadableOptions::dumpVar_int	(	CStream &	out,
		const char *	varName,
		int	v
	)		[static, protected, inherited]

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

static void mrpt::utils::CLoadableOptions::dumpVar_string	(	CStream &	out,
		const char *	varName,
		const std::string &	v
	)		[static, protected, inherited]

void mrpt::slam::CColouredPointsMap::TColourOptions::loadFromConfigFile	(	const mrpt::utils::CConfigFileBase &	source,
		const std::string &	section
	)		[virtual]

See utils::CLoadableOptions.

Implements mrpt::utils::CLoadableOptions.

void mrpt::utils::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

virtual void mrpt::utils::CLoadableOptions::saveToConfigFile	(	mrpt::utils::CConfigFileBase &	source,
		const std::string &	section
	)		[inline, virtual, inherited]

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

See also:

loadFromConfigFile, saveToConfigFileName

Reimplemented in mrpt::vision::TMultiResDescOptions, and mrpt::vision::TMultiResDescMatchOptions.

Definition at line 87 of file CLoadableOptions.h.

References THROW_EXCEPTION.

void mrpt::utils::CLoadableOptions::saveToConfigFileName	(	const std::string &	config_file,
		const std::string &	section
	)		[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

---

Member Data Documentation

float mrpt::slam::CColouredPointsMap::TColourOptions::d_max

Definition at line 248 of file CColouredPointsMap.h.

TColouringMethod mrpt::slam::CColouredPointsMap::TColourOptions::scheme

Definition at line 246 of file CColouredPointsMap.h.

float mrpt::slam::CColouredPointsMap::TColourOptions::z_max

Definition at line 247 of file CColouredPointsMap.h.

float mrpt::slam::CColouredPointsMap::TColourOptions::z_min

Definition at line 247 of file CColouredPointsMap.h.