Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Classes | Public Member Functions | Public Attributes | Static Protected Member Functions
mrpt::vision::CFeatureExtraction::TOptions Struct Reference

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:
Inheritance graph

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.
 
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.
 
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.
 
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 &target, const std::string &section) const
 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) 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.
 
void dumpToConsole () const
 Just like dumpToTextStream() but sending the text to the console (std::cout)
 

Public Attributes

TFeatureType featsType
 Type of the extracted features.
 
unsigned int patchSize
 Size of the patch to extract, or 0 if no patch is desired (default=21).
 
bool useMask
 Whether to use a mask for determining the regions where not to look for keypoints (default=false).
 
bool addNewFeatures
 Whether to add the found features to the input feature list or clear it before adding them (default=false).
 
bool FIND_SUBPIXEL
 Indicates if subpixel accuracy is desired for the extracted points (only applicable to KLT and Harris features)
 
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.
 
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()

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

Initalizer.

Member Function Documentation

◆ dumpToConsole()

void mrpt::utils::CLoadableOptions::dumpToConsole ( ) const
inherited

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

◆ dumpToTextStream()

void mrpt::vision::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.

◆ dumpVar_bool()

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

◆ dumpVar_double()

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

◆ dumpVar_float()

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

◆ dumpVar_int()

static void mrpt::utils::CLoadableOptions::dumpVar_int ( CStream out,
const char *  varName,
int  v 
)
staticprotectedinherited

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

◆ dumpVar_string()

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

◆ loadFromConfigFile()

void mrpt::vision::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.

◆ loadFromConfigFileName()

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

◆ saveToConfigFile()

virtual void mrpt::utils::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::nav::CHolonomicND::TOptions, mrpt::nav::CHolonomicVFF::TOptions, mrpt::vision::TMultiResDescMatchOptions, and mrpt::vision::TMultiResDescOptions.

◆ saveToConfigFileName()

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

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.

◆ 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

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

◆ harrisOptions

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

◆ KLTOptions

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

◆ LogPolarImagesOptions

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

◆ ORBOptions

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

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

◆ PolarImagesOptions

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

◆ SIFTOptions

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

◆ SpinImagesOptions

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

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




Page generated by Doxygen 1.9.8 for MRPT 1.4.0 SVN: at Fri Dec 15 05:36:48 UTC 2023