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

Detailed Description

Struct containing the options when computing the multi-resolution SIFT-like descriptors.

Definition at line 466 of file vision/include/mrpt/vision/types.h.

#include <mrpt/vision/types.h>

Inheritance diagram for mrpt::vision::TMultiResDescOptions:
Inheritance graph

Public Member Functions

 TMultiResDescOptions ()
 Default constructor. More...
 
 TMultiResDescOptions (const unsigned int &_basePSize, const std::vector< double > &_scales, const unsigned int &_comLScl, const unsigned int &_comHScl, const double &_sg1, const double &_sg2, const double &_sg3, const bool &_computeDepth, const bool _blurImage, const double &_fx, const double &_cx, const double &_cy, const double &_baseline, const bool &_computeHashCoeffs, const double &_cropValue)
 
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 saveToConfigFile (mrpt::utils::CConfigFileBase &cfg, const std::string &section) const MRPT_OVERRIDE
 This method saves the options to 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...
 
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 basePSize
 The size of the base patch. More...
 
std::vector< double > scales
 The set of scales relatives to the base patch. More...
 
uint32_t comLScl
 
uint32_t comHScl
 The subset of scales for which to compute the descriptors. More...
 
double sg1
 
double sg2
 
double sg3
 The sigmas for the Gaussian kernels. More...
 
bool computeDepth
 Whether or not to compute the depth of the feature. More...
 
bool blurImage
 Whether or not to blur the image previously to compute the descriptors. More...
 
double fx
 
double cx
 
double cy
 
double baseline
 Intrinsic stereo pair parameters for computing the depth of the feature. More...
 
bool computeHashCoeffs
 Whether or not compute the coefficients for mantaining a HASH table of descriptors (for relocalization) More...
 
double cropValue
 The SIFT-like descriptor is cropped at this value during normalization. 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

◆ TMultiResDescOptions() [1/2]

mrpt::vision::TMultiResDescOptions::TMultiResDescOptions ( )
inline

Default constructor.

Definition at line 481 of file vision/include/mrpt/vision/types.h.

◆ TMultiResDescOptions() [2/2]

mrpt::vision::TMultiResDescOptions::TMultiResDescOptions ( const unsigned int &  _basePSize,
const std::vector< double > &  _scales,
const unsigned int &  _comLScl,
const unsigned int &  _comHScl,
const double &  _sg1,
const double &  _sg2,
const double &  _sg3,
const bool &  _computeDepth,
const bool  _blurImage,
const double &  _fx,
const double &  _cx,
const double &  _cy,
const double &  _baseline,
const bool &  _computeHashCoeffs,
const double &  _cropValue 
)
inline

Definition at line 496 of file vision/include/mrpt/vision/types.h.

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::TMultiResDescOptions::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::TMultiResDescOptions::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()

void mrpt::vision::TMultiResDescOptions::saveToConfigFile ( mrpt::utils::CConfigFileBase target,
const std::string &  section 
) const
virtual

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

See also
loadFromConfigFile, saveToConfigFileName

Reimplemented from mrpt::utils::CLoadableOptions.

◆ 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

◆ baseline

double mrpt::vision::TMultiResDescOptions::baseline

Intrinsic stereo pair parameters for computing the depth of the feature.

Definition at line 474 of file vision/include/mrpt/vision/types.h.

◆ basePSize

uint32_t mrpt::vision::TMultiResDescOptions::basePSize

The size of the base patch.

Definition at line 468 of file vision/include/mrpt/vision/types.h.

◆ blurImage

bool mrpt::vision::TMultiResDescOptions::blurImage

Whether or not to blur the image previously to compute the descriptors.

Definition at line 473 of file vision/include/mrpt/vision/types.h.

◆ comHScl

uint32_t mrpt::vision::TMultiResDescOptions::comHScl

The subset of scales for which to compute the descriptors.

Definition at line 470 of file vision/include/mrpt/vision/types.h.

◆ comLScl

uint32_t mrpt::vision::TMultiResDescOptions::comLScl

Definition at line 470 of file vision/include/mrpt/vision/types.h.

◆ computeDepth

bool mrpt::vision::TMultiResDescOptions::computeDepth

Whether or not to compute the depth of the feature.

Definition at line 472 of file vision/include/mrpt/vision/types.h.

◆ computeHashCoeffs

bool mrpt::vision::TMultiResDescOptions::computeHashCoeffs

Whether or not compute the coefficients for mantaining a HASH table of descriptors (for relocalization)

Definition at line 475 of file vision/include/mrpt/vision/types.h.

◆ cropValue

double mrpt::vision::TMultiResDescOptions::cropValue

The SIFT-like descriptor is cropped at this value during normalization.

Definition at line 477 of file vision/include/mrpt/vision/types.h.

◆ cx

double mrpt::vision::TMultiResDescOptions::cx

Definition at line 474 of file vision/include/mrpt/vision/types.h.

◆ cy

double mrpt::vision::TMultiResDescOptions::cy

Definition at line 474 of file vision/include/mrpt/vision/types.h.

◆ fx

double mrpt::vision::TMultiResDescOptions::fx

Definition at line 474 of file vision/include/mrpt/vision/types.h.

◆ scales

std::vector<double> mrpt::vision::TMultiResDescOptions::scales

The set of scales relatives to the base patch.

Definition at line 469 of file vision/include/mrpt/vision/types.h.

◆ sg1

double mrpt::vision::TMultiResDescOptions::sg1

Definition at line 471 of file vision/include/mrpt/vision/types.h.

◆ sg2

double mrpt::vision::TMultiResDescOptions::sg2

Definition at line 471 of file vision/include/mrpt/vision/types.h.

◆ sg3

double mrpt::vision::TMultiResDescOptions::sg3

The sigmas for the Gaussian kernels.

Definition at line 471 of file vision/include/mrpt/vision/types.h.




Page generated by Doxygen 1.9.4 for MRPT 1.4.0 SVN: at Sun Aug 14 11:28:23 UTC 2022