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

Detailed Description

A structure containing options for the matching.

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

#include <mrpt/vision/types.h>

Inheritance diagram for mrpt::vision::TMatchingOptions:
Inheritance graph

Public Types

enum  TMatchingMethod {
  mmCorrelation = 0, mmDescriptorSIFT, mmDescriptorSURF, mmSAD,
  mmDescriptorORB
}
 Method for propagating the feature's image coordinate uncertainty into 3D space. More...
 

Public Member Functions

 TMatchingOptions ()
 Intrinsic parameters of the stereo rig. More...
 
void loadFromConfigFile (const mrpt::config::CConfigFileBase &source, const std::string &section) 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...
 
bool operator== (const TMatchingOptions &o) const
 
void operator= (const TMatchingOptions &o)
 
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

bool useEpipolarRestriction
 Whether or not take into account the epipolar restriction for finding correspondences. More...
 
bool hasFundamentalMatrix
 Whether or not there is a fundamental matrix. More...
 
bool parallelOpticalAxis
 Whether or not the stereo rig has the optical axes parallel. More...
 
bool useXRestriction
 Whether or not employ the x-coord restriction for finding correspondences (bumblebee camera, for example) More...
 
bool addMatches
 Whether or not to add the matches found into the input matched list (if false the input list will be cleared before being filled with the new matches) More...
 
bool useDisparityLimits
 Whether or not use limits (min,max) for the disparity, see also 'min_disp, max_disp'. More...
 
bool enable_robust_1to1_match
 Whether or not only permit matches that are consistent from left->right and right->left. More...
 
float min_disp
 Disparity limits, see also 'useDisparityLimits'. More...
 
float max_disp
 
mrpt::math::CMatrixDouble33 F
 
TMatchingMethod matching_method
 Matching method. More...
 
float epipolar_TH
 Epipolar constraint (rows of pixels) More...
 
float maxEDD_TH
 Maximum Euclidean Distance Between SIFT Descriptors. More...
 
float EDD_RATIO
 Boundary Ratio between the two lowest EDD. More...
 
float minCC_TH
 Minimum Value of the Cross Correlation. More...
 
float minDCC_TH
 Minimum Difference Between the Maximum Cross Correlation Values. More...
 
float rCC_TH
 Maximum Ratio Between the two highest CC values. More...
 
float maxEDSD_TH
 Maximum Euclidean Distance Between SURF Descriptors. More...
 
float EDSD_RATIO
 Boundary Ratio between the two lowest SURF EDSD. More...
 
double maxSAD_TH
 Minimum Euclidean Distance Between Sum of Absolute Differences. More...
 
double SAD_RATIO
 Boundary Ratio between the two highest SAD. More...
 
double maxORB_dist
 Maximun distance between ORB descriptors. More...
 
bool estimateDepth
 Whether or not estimate the 3D position of the real features for the matches (only with parallelOpticalAxis by now). More...
 
double maxDepthThreshold
 The maximum allowed depth for the matching. More...
 

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)
 

Member Enumeration Documentation

◆ TMatchingMethod

Method for propagating the feature's image coordinate uncertainty into 3D space.

Default value: Prop_Linear

Enumerator
mmCorrelation 

Matching by cross correlation of the image patches.

mmDescriptorSIFT 

Matching by Euclidean distance between SIFT descriptors.

mmDescriptorSURF 

Matching by Euclidean distance between SURF descriptors.

mmSAD 

Matching by sum of absolute differences of the image patches.

mmDescriptorORB 

Matching by Hamming distance between ORB descriptors.

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

Constructor & Destructor Documentation

◆ TMatchingOptions()

TMatchingOptions::TMatchingOptions ( )

Intrinsic parameters of the stereo rig.

Constructor

Definition at line 2401 of file vision_utils.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 44 of file CLoadableOptions.cpp.

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

Referenced by mrpt::hmtslam::CTopLCDetector_GridMatching::computeTopologicalObservationModel().

◆ dumpToTextStream()

void TMatchingOptions::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 2517 of file vision_utils.cpp.

References addMatches, EDD_RATIO, EDSD_RATIO, epipolar_TH, estimateDepth, mrpt::format(), hasFundamentalMatrix, matching_method, max_disp, maxDepthThreshold, maxEDD_TH, maxEDSD_TH, maxORB_dist, maxSAD_TH, min_disp, minCC_TH, minDCC_TH, mmCorrelation, mmDescriptorORB, mmDescriptorSIFT, mmDescriptorSURF, mmSAD, parallelOpticalAxis, rCC_TH, SAD_RATIO, useDisparityLimits, useEpipolarRestriction, and useXRestriction.

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

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

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

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

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

◆ loadFromConfigFile()

void TMatchingOptions::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 2450 of file vision_utils.cpp.

References addMatches, EDD_RATIO, EDSD_RATIO, epipolar_TH, estimateDepth, hasFundamentalMatrix, iniFile(), matching_method, max_disp, maxDepthThreshold, maxEDD_TH, maxEDSD_TH, maxORB_dist, maxSAD_TH, min_disp, minCC_TH, minDCC_TH, mmCorrelation, mmDescriptorORB, mmDescriptorSIFT, mmDescriptorSURF, mmSAD, parallelOpticalAxis, rCC_TH, SAD_RATIO, useDisparityLimits, useEpipolarRestriction, and useXRestriction.

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

◆ operator=()

void mrpt::vision::TMatchingOptions::operator= ( const TMatchingOptions o)
inline

◆ operator==()

bool mrpt::vision::TMatchingOptions::operator== ( const TMatchingOptions o) const
inline

◆ 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::nav::CAbstractPTGBasedReactive::TAbstractPTGNavigatorParams, mrpt::nav::CAbstractNavigator::TAbstractNavigatorParams, mrpt::nav::CPTG_DiffDrive_CollisionGridBased, mrpt::nav::CWaypointsNavigator::TWaypointsNavigatorParams, mrpt::nav::CHolonomicFullEval::TOptions, mrpt::bayes::CParticleFilter::TParticleFilterOptions, mrpt::nav::CReactiveNavigationSystem::TReactiveNavigatorParams, mrpt::nav::CHolonomicND::TOptions, 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().

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

Member Data Documentation

◆ addMatches

bool mrpt::vision::TMatchingOptions::addMatches

Whether or not to add the matches found into the input matched list (if false the input list will be cleared before being filled with the new matches)

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ EDD_RATIO

float mrpt::vision::TMatchingOptions::EDD_RATIO

◆ EDSD_RATIO

float mrpt::vision::TMatchingOptions::EDSD_RATIO

Boundary Ratio between the two lowest SURF EDSD.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ enable_robust_1to1_match

bool mrpt::vision::TMatchingOptions::enable_robust_1to1_match

Whether or not only permit matches that are consistent from left->right and right->left.

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

Referenced by operator=(), and operator==().

◆ epipolar_TH

float mrpt::vision::TMatchingOptions::epipolar_TH

◆ estimateDepth

bool mrpt::vision::TMatchingOptions::estimateDepth

Whether or not estimate the 3D position of the real features for the matches (only with parallelOpticalAxis by now).

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ F

mrpt::math::CMatrixDouble33 mrpt::vision::TMatchingOptions::F

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

Referenced by operator=(), and operator==().

◆ hasFundamentalMatrix

bool mrpt::vision::TMatchingOptions::hasFundamentalMatrix

Whether or not there is a fundamental matrix.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ matching_method

TMatchingMethod mrpt::vision::TMatchingOptions::matching_method

◆ max_disp

float mrpt::vision::TMatchingOptions::max_disp

◆ maxDepthThreshold

double mrpt::vision::TMatchingOptions::maxDepthThreshold

The maximum allowed depth for the matching.

If its computed depth is larger than this, the match won't be considered.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ maxEDD_TH

float mrpt::vision::TMatchingOptions::maxEDD_TH

◆ maxEDSD_TH

float mrpt::vision::TMatchingOptions::maxEDSD_TH

Maximum Euclidean Distance Between SURF Descriptors.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ maxORB_dist

double mrpt::vision::TMatchingOptions::maxORB_dist

Maximun distance between ORB descriptors.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ maxSAD_TH

double mrpt::vision::TMatchingOptions::maxSAD_TH

Minimum Euclidean Distance Between Sum of Absolute Differences.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ min_disp

float mrpt::vision::TMatchingOptions::min_disp

Disparity limits, see also 'useDisparityLimits'.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), operator=(), and operator==().

◆ minCC_TH

float mrpt::vision::TMatchingOptions::minCC_TH

◆ minDCC_TH

float mrpt::vision::TMatchingOptions::minDCC_TH

Minimum Difference Between the Maximum Cross Correlation Values.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), operator=(), and operator==().

◆ parallelOpticalAxis

bool mrpt::vision::TMatchingOptions::parallelOpticalAxis

Whether or not the stereo rig has the optical axes parallel.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ rCC_TH

float mrpt::vision::TMatchingOptions::rCC_TH

Maximum Ratio Between the two highest CC values.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ SAD_RATIO

double mrpt::vision::TMatchingOptions::SAD_RATIO

Boundary Ratio between the two highest SAD.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ useDisparityLimits

bool mrpt::vision::TMatchingOptions::useDisparityLimits

Whether or not use limits (min,max) for the disparity, see also 'min_disp, max_disp'.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), operator=(), and operator==().

◆ useEpipolarRestriction

bool mrpt::vision::TMatchingOptions::useEpipolarRestriction

Whether or not take into account the epipolar restriction for finding correspondences.

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().

◆ useXRestriction

bool mrpt::vision::TMatchingOptions::useXRestriction

Whether or not employ the x-coord restriction for finding correspondences (bumblebee camera, for example)

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

Referenced by dumpToTextStream(), loadFromConfigFile(), mrpt::vision::matchFeatures(), operator=(), and operator==().




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at lun oct 28 00:14:14 CET 2019