Detailed Description

The set of parameters for all the detectors & descriptor algorithms.

Definition at line 72 of file CFeatureExtraction.h.

#include <mrpt/vision/CFeatureExtraction.h>

Inheritance diagram for mrpt::vision::CFeatureExtraction::TOptions:

Classes
struct	TBCDOptions
	BCD Options. More...

struct	TFASTOptions
	FAST and FASTER Options. More...

struct	THarrisOptions
	Harris Options. More...

struct	TKLTOptions
	KLT Options. More...

struct	TLogPolarImagesOptions
	LogPolarImagesOptions Options. More...

struct	TORBOptions
	ORB Options. More...

struct	TPolarImagesOptions
	PolarImagesOptions Options. More...

struct	TSIFTOptions
	SIFT Options. More...

struct	TSpinImagesOptions

struct	TSURFOptions

Public Member Functions
	TOptions (const TFeatureType featsType=featKLT)
	Initalizer. More...

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	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
TFeatureType	featsType
	Type of the extracted features. More...

unsigned int	patchSize
	Size of the patch to extract, or 0 if no patch is desired (default=21). More...

bool	useMask
	Whether to use a mask for determining the regions where not to look for keypoints (default=false). More...

bool	addNewFeatures
	Whether to add the found features to the input feature list or clear it before adding them (default=false). More...

bool	FIND_SUBPIXEL
	Indicates if subpixel accuracy is desired for the extracted points (only applicable to KLT and Harris features) More...

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TKLTOptions	KLTOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::THarrisOptions	harrisOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TBCDOptions	BCDOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TFASTOptions	FASTOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TORBOptions	ORBOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TSIFTOptions	SIFTOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TSURFOptions	SURFOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TSpinImagesOptions	SpinImagesOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TPolarImagesOptions	PolarImagesOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TLogPolarImagesOptions	LogPolarImagesOptions

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

◆ TOptions()

CFeatureExtraction::TOptions::TOptions ( const TFeatureType featsType = featKLT )

Initalizer.

Definition at line 278 of file CFeatureExtraction_common.cpp.

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 CFeatureExtraction::TOptions::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 342 of file CFeatureExtraction_common.cpp.

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

Referenced by mrpt::maps::CLandmarksMap::TLikelihoodOptions::dumpToTextStream().

◆ 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 CFeatureExtraction::TOptions::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 399 of file CFeatureExtraction_common.cpp.

References MRPT_LOAD_CONFIG_VAR, and MRPT_LOAD_CONFIG_VAR_CAST.

Referenced by mrpt::maps::CLandmarksMap::TLikelihoodOptions::loadFromConfigFile().

◆ 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

◆ addNewFeatures

bool mrpt::vision::CFeatureExtraction::TOptions::addNewFeatures

Whether to add the found features to the input feature list or clear it before adding them (default=false).

Definition at line 94 of file CFeatureExtraction.h.

Referenced by TOptions().

◆ BCDOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TBCDOptions mrpt::vision::CFeatureExtraction::TOptions::BCDOptions

◆ FASTOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TFASTOptions mrpt::vision::CFeatureExtraction::TOptions::FASTOptions

Referenced by TOptions().

◆ featsType

TFeatureType mrpt::vision::CFeatureExtraction::TOptions::featsType

Type of the extracted features.

Definition at line 82 of file CFeatureExtraction.h.

◆ FIND_SUBPIXEL

bool mrpt::vision::CFeatureExtraction::TOptions::FIND_SUBPIXEL

Indicates if subpixel accuracy is desired for the extracted points (only applicable to KLT and Harris features)

Definition at line 98 of file CFeatureExtraction.h.

Referenced by TOptions().

◆ harrisOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::THarrisOptions mrpt::vision::CFeatureExtraction::TOptions::harrisOptions

Referenced by TOptions().

◆ KLTOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TKLTOptions mrpt::vision::CFeatureExtraction::TOptions::KLTOptions

Referenced by TOptions().

◆ LogPolarImagesOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TLogPolarImagesOptions mrpt::vision::CFeatureExtraction::TOptions::LogPolarImagesOptions

Referenced by TOptions().

◆ ORBOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TORBOptions mrpt::vision::CFeatureExtraction::TOptions::ORBOptions

Referenced by TOptions().

◆ patchSize

unsigned int mrpt::vision::CFeatureExtraction::TOptions::patchSize

Size of the patch to extract, or 0 if no patch is desired (default=21).

Definition at line 86 of file CFeatureExtraction.h.

Referenced by TOptions(), and mrpt::slam::COccupancyGridMapFeatureExtractor::uncached_extractFeatures().

◆ PolarImagesOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TPolarImagesOptions mrpt::vision::CFeatureExtraction::TOptions::PolarImagesOptions

Referenced by TOptions().

◆ SIFTOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TSIFTOptions mrpt::vision::CFeatureExtraction::TOptions::SIFTOptions

Referenced by TOptions().

◆ SpinImagesOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TSpinImagesOptions mrpt::vision::CFeatureExtraction::TOptions::SpinImagesOptions

Referenced by TOptions().

◆ SURFOptions

struct VISION_IMPEXP mrpt::vision::CFeatureExtraction::TOptions::TSURFOptions mrpt::vision::CFeatureExtraction::TOptions::SURFOptions

◆ useMask

bool mrpt::vision::CFeatureExtraction::TOptions::useMask

Whether to use a mask for determining the regions where not to look for keypoints (default=false).

Definition at line 90 of file CFeatureExtraction.h.

Referenced by TOptions().

Detailed Description

Classes

Public Member Functions

Public Attributes

Static Protected Member Functions

Constructor & Destructor Documentation

◆ TOptions()

Member Function Documentation

◆ dumpToConsole()

◆ dumpToTextStream()

◆ dumpVar_bool()

◆ dumpVar_double()

◆ dumpVar_float()

◆ dumpVar_int()

◆ dumpVar_string()

◆ loadFromConfigFile()

◆ loadFromConfigFileName()

◆ saveToConfigFile()

◆ saveToConfigFileName()

Member Data Documentation

◆ addNewFeatures

◆ BCDOptions

◆ FASTOptions

◆ featsType

◆ FIND_SUBPIXEL

◆ harrisOptions

◆ KLTOptions

◆ LogPolarImagesOptions

◆ ORBOptions

◆ patchSize

◆ PolarImagesOptions

◆ SIFTOptions

◆ SpinImagesOptions

◆ SURFOptions

◆ useMask