MRPT  1.9.9
mrpt::vision::CFeatureExtraction::TOptions Struct Reference

Detailed Description

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

Definition at line 95 of file CFeatureExtraction.h.

#include <mrpt/vision/CFeatureExtraction.h>

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

Classes

struct  TAKAZEOptions
 AKAZEOptions Options. More...
 
struct  TBCDOptions
 BCD Options. More...
 
struct  TBLDOptions
 BLDOptions Descriptor Options. More...
 
struct  TFASTOptions
 FAST and FASTER Options. More...
 
struct  THarrisOptions
 Harris Options. More...
 
struct  TKLTOptions
 KLT Options. More...
 
struct  TLATCHOptions
 LATCHOptions Descriptor. More...
 
struct  TLogPolarImagesOptions
 LogPolarImagesOptions Options. More...
 
struct  TLSDOptions
 LSDOptions Options. More...
 
struct  TORBOptions
 ORB Options. More...
 
struct  TPolarImagesOptions
 PolarImagesOptions options. More...
 
struct  TSIFTOptions
 SIFT Options. More...
 
struct  TSpinImagesOptions
 SpinImages Options. More...
 
struct  TSURFOptions
 SURF Options. More...
 

Public Member Functions

 TOptions ()=default
 
 TOptions (const TKeyPointMethod ft)
 
void loadFromConfigFile (const mrpt::config::CConfigFileBase &c, const std::string &s) override
 This method load the options from a ".ini"-like file or memory-stored string list. More...
 
void dumpToTextStream (std::ostream &out) const override
 This method should clearly display all the contents of the structure in textual form, sending it to a std::ostream. 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::config::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

TKeyPointMethod featsType {featKLT}
 Type of the extracted features. More...
 
unsigned int patchSize {21}
 Size of the patch to extract, or 0 if no patch is desired (default=21). More...
 
bool useMask {false}
 Whether to use a mask for determining the regions where not to look for keypoints (default=false). More...
 
bool addNewFeatures {false}
 Whether to add the found features to the input feature list or clear it before adding them (default=false). More...
 
bool FIND_SUBPIXEL {true}
 Indicates if subpixel accuracy is desired for the extracted points (only applicable to KLT and Harris features) More...
 
struct mrpt::vision::CFeatureExtraction::TOptions::TKLTOptions KLTOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::THarrisOptions harrisOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TBCDOptions BCDOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TFASTOptions FASTOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TORBOptions ORBOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TSIFTOptions SIFTOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TSURFOptions SURFOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TSpinImagesOptions SpinImagesOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TPolarImagesOptions PolarImagesOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TLogPolarImagesOptions LogPolarImagesOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TAKAZEOptions AKAZEOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TLSDOptions LSDOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TBLDOptions BLDOptions
 
struct mrpt::vision::CFeatureExtraction::TOptions::TLATCHOptions LATCHOptions
 

Static Protected Member Functions

static void dumpVar_int (std::ostream &out, const char *varName, int v)
 Used to print variable info from dumpToTextStream with the macro LOADABLEOPTS_DUMP_VAR. More...
 
static void dumpVar_float (std::ostream &out, const char *varName, float v)
 
static void dumpVar_double (std::ostream &out, const char *varName, double v)
 
static void dumpVar_bool (std::ostream &out, const char *varName, bool v)
 
static void dumpVar_string (std::ostream &out, const char *varName, const std::string &v)
 

Constructor & Destructor Documentation

◆ TOptions() [1/2]

mrpt::vision::CFeatureExtraction::TOptions::TOptions ( )
default

◆ TOptions() [2/2]

mrpt::vision::CFeatureExtraction::TOptions::TOptions ( const TKeyPointMethod  ft)
inline

Definition at line 98 of file CFeatureExtraction.h.

References featsType.

Member Function Documentation

◆ dumpToConsole()

void CLoadableOptions::dumpToConsole ( ) const
inherited

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

Definition at line 44 of file CLoadableOptions.cpp.

References mrpt::config::CLoadableOptions::dumpToTextStream().

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel(), and mrpt::ros1bridge::MapHdl::loadMap().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ dumpToTextStream()

void CFeatureExtraction::TOptions::dumpToTextStream ( std::ostream &  out) const
overridevirtual

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

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

Reimplemented from mrpt::config::CLoadableOptions.

Definition at line 157 of file CFeatureExtraction_common.cpp.

References mrpt::format(), and LOADABLEOPTS_DUMP_VAR.

Here is the call graph for this function:

◆ dumpVar_bool()

void CLoadableOptions::dumpVar_bool ( std::ostream &  out,
const char *  varName,
bool  v 
)
staticprotectedinherited

Definition at line 63 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ dumpVar_double()

void CLoadableOptions::dumpVar_double ( std::ostream &  out,
const char *  varName,
double  v 
)
staticprotectedinherited

Definition at line 57 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ dumpVar_float()

void CLoadableOptions::dumpVar_float ( std::ostream &  out,
const char *  varName,
float  v 
)
staticprotectedinherited

Definition at line 51 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ dumpVar_int()

void CLoadableOptions::dumpVar_int ( std::ostream &  out,
const char *  varName,
int  v 
)
staticprotectedinherited

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

Definition at line 45 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ dumpVar_string()

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

Definition at line 70 of file CLoadableOptions.cpp.

References mrpt::format(), and LOADABLEOPTS_COLUMN_WIDTH.

Here is the call graph for this function:

◆ loadFromConfigFile()

void CFeatureExtraction::TOptions::loadFromConfigFile ( const mrpt::config::CConfigFileBase source,
const std::string section 
)
overridevirtual

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::config::CLoadableOptions.

Definition at line 235 of file CFeatureExtraction_common.cpp.

References iniFile(), MRPT_LOAD_CONFIG_VAR, and MRPT_LOAD_CONFIG_VAR_CAST.

Here is the call graph for this function:

◆ 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 22 of file CLoadableOptions.cpp.

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

Here is the call graph for this function:

◆ saveToConfigFile()

void CLoadableOptions::saveToConfigFile ( mrpt::config::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::maps::TSetOfMetricMapInitializers, mrpt::maps::COccupancyGridMap3D::TLikelihoodOptions, mrpt::nav::CAbstractNavigator::TAbstractNavigatorParams, mrpt::nav::CAbstractPTGBasedReactive::TAbstractPTGNavigatorParams, mrpt::maps::COccupancyGridMap3D::TInsertionOptions, mrpt::nav::CPTG_DiffDrive_CollisionGridBased, mrpt::nav::CWaypointsNavigator::TWaypointsNavigatorParams, mrpt::nav::CHolonomicFullEval::TOptions, mrpt::bayes::CParticleFilter::TParticleFilterOptions, mrpt::nav::CHolonomicND::TOptions, mrpt::nav::CReactiveNavigationSystem::TReactiveNavigatorParams, mrpt::maps::TMapGenericParams, mrpt::nav::CMultiObjectiveMotionOptimizerBase::TParamsBase, mrpt::nav::CHolonomicVFF::TOptions, mrpt::slam::CICP::TConfigParams, mrpt::slam::CIncrementalMapPartitioner::TOptions, mrpt::maps::CPointCloudFilterByDistance::TOptions, mrpt::nav::CPTG_DiffDrive_C, mrpt::maps::TMetricMapInitializer, 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 29 of file CLoadableOptions.cpp.

References MRPT_UNUSED_PARAM.

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

Here is the caller graph for this function:

◆ 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 37 of file CLoadableOptions.cpp.

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

Here is the call graph for this function:

Member Data Documentation

◆ addNewFeatures

bool mrpt::vision::CFeatureExtraction::TOptions::addNewFeatures {false}

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

Definition at line 122 of file CFeatureExtraction.h.

◆ AKAZEOptions

struct mrpt::vision::CFeatureExtraction::TOptions::TAKAZEOptions mrpt::vision::CFeatureExtraction::TOptions::AKAZEOptions

◆ BCDOptions

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

◆ BLDOptions

struct mrpt::vision::CFeatureExtraction::TOptions::TBLDOptions mrpt::vision::CFeatureExtraction::TOptions::BLDOptions

◆ FASTOptions

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

◆ featsType

TKeyPointMethod mrpt::vision::CFeatureExtraction::TOptions::featsType {featKLT}

Type of the extracted features.

Definition at line 107 of file CFeatureExtraction.h.

Referenced by TOptions().

◆ FIND_SUBPIXEL

bool mrpt::vision::CFeatureExtraction::TOptions::FIND_SUBPIXEL {true}

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

Definition at line 127 of file CFeatureExtraction.h.

◆ harrisOptions

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

◆ KLTOptions

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

◆ LATCHOptions

struct mrpt::vision::CFeatureExtraction::TOptions::TLATCHOptions mrpt::vision::CFeatureExtraction::TOptions::LATCHOptions

◆ LogPolarImagesOptions

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

◆ LSDOptions

struct mrpt::vision::CFeatureExtraction::TOptions::TLSDOptions mrpt::vision::CFeatureExtraction::TOptions::LSDOptions

◆ ORBOptions

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

◆ patchSize

unsigned int mrpt::vision::CFeatureExtraction::TOptions::patchSize {21}

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

Definition at line 112 of file CFeatureExtraction.h.

Referenced by mrpt::slam::COccupancyGridMapFeatureExtractor::uncached_extractFeatures().

◆ PolarImagesOptions

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

◆ SIFTOptions

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

◆ SpinImagesOptions

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

◆ SURFOptions

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

◆ useMask

bool mrpt::vision::CFeatureExtraction::TOptions::useMask {false}

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

Definition at line 117 of file CFeatureExtraction.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ce1a28c9f Fri Aug 23 08:02:09 2019 +0200 at vie ago 23 08:10:11 CEST 2019