Visual Servoing Platform  version 3.4.0 under development (2021-03-03)

#include <visp3/vision/vpXmlConfigParserKeyPoint.h>

Public Types

enum  vpMatchingMethodEnum {
  constantFactorDistanceThreshold, stdDistanceThreshold, ratioDistanceThreshold, stdAndRatioDistanceThreshold,
  noFilterMatching
}
 

Public Member Functions

 vpXmlConfigParserKeyPoint ()
 
 ~vpXmlConfigParserKeyPoint ()
 
std::string getDetectorName () const
 
std::string getExtractorName () const
 
std::string getMatcherName () const
 
double getMatchingFactorThreshold () const
 
vpMatchingMethodEnum getMatchingMethod () const
 
double getMatchingRatioThreshold () const
 
int getNbRansacIterations () const
 
int getNbRansacMinInlierCount () const
 
double getRansacConsensusPercentage () const
 
double getRansacReprojectionError () const
 
double getRansacThreshold () const
 
bool getUseRansacConsensusPercentage () const
 
bool getUseRansacVVSPoseEstimation () const
 
void parse (const std::string &filename)
 

Detailed Description

Warning
This class is only available if pugixml is successfully built.

Definition at line 61 of file vpXmlConfigParserKeyPoint.h.

Member Enumeration Documentation

◆ vpMatchingMethodEnum

Enumerator for the different filtering matching method.

Enumerator
constantFactorDistanceThreshold 

Keep all the points below a constant factor threshold.

stdDistanceThreshold 

Keep all the points below a minimal distance + the standard deviation.

ratioDistanceThreshold 

Keep all the points enough discriminated.

stdAndRatioDistanceThreshold 

Keep all the points which fall with the two conditions.

noFilterMatching 

No filtering.

Definition at line 65 of file vpXmlConfigParserKeyPoint.h.

Constructor & Destructor Documentation

◆ vpXmlConfigParserKeyPoint()

vpXmlConfigParserKeyPoint::vpXmlConfigParserKeyPoint ( )

Definition at line 508 of file vpXmlConfigParserKeyPoint.cpp.

◆ ~vpXmlConfigParserKeyPoint()

vpXmlConfigParserKeyPoint::~vpXmlConfigParserKeyPoint ( )

Definition at line 512 of file vpXmlConfigParserKeyPoint.cpp.

Member Function Documentation

◆ getDetectorName()

std::string vpXmlConfigParserKeyPoint::getDetectorName ( ) const

Get the detector name.

Returns
The detector name.

Definition at line 531 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getExtractorName()

std::string vpXmlConfigParserKeyPoint::getExtractorName ( ) const

Get the extractor name.

Returns
The extractor name.

Definition at line 541 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getMatcherName()

std::string vpXmlConfigParserKeyPoint::getMatcherName ( ) const

Get the matcher name.

Returns
The detector name.

Definition at line 551 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getMatchingFactorThreshold()

double vpXmlConfigParserKeyPoint::getMatchingFactorThreshold ( ) const

Get the factor value.

Returns
The factor value for the filtering method: constantFactorDistanceThreshold.

Definition at line 562 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getMatchingMethod()

vpXmlConfigParserKeyPoint::vpMatchingMethodEnum vpXmlConfigParserKeyPoint::getMatchingMethod ( ) const

Get the filtering method.

Returns
The filtering method.

Definition at line 572 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getMatchingRatioThreshold()

double vpXmlConfigParserKeyPoint::getMatchingRatioThreshold ( ) const

Get the ratio value.

Returns
The factor value for the filtering method: ratioDistanceThreshold.

Definition at line 582 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getNbRansacIterations()

int vpXmlConfigParserKeyPoint::getNbRansacIterations ( ) const

Get the maximum number of iterations for the Ransac method.

Returns
The maximum number of iterations for the Ransac method.

Definition at line 592 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getNbRansacMinInlierCount()

int vpXmlConfigParserKeyPoint::getNbRansacMinInlierCount ( ) const

Get the minimum number of inliers for the Ransac method.

Returns
The minimum number of inliers for the Ransac method.

Definition at line 602 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getRansacConsensusPercentage()

double vpXmlConfigParserKeyPoint::getRansacConsensusPercentage ( ) const

Get the percentage value of inliers for the Ransac method.

Returns
The percentage value of inliers for the Ransac method.

Definition at line 612 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getRansacReprojectionError()

double vpXmlConfigParserKeyPoint::getRansacReprojectionError ( ) const

Get the maximum reprojection error for a candidate inlier for the Ransac method.

Returns
The maximum reprojection error for the Ransac method.

Definition at line 623 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getRansacThreshold()

double vpXmlConfigParserKeyPoint::getRansacThreshold ( ) const

Get the maximum error for a candidate inlier for the Ransac method.

Returns
The maximum error for the Ransac method.

Definition at line 633 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getUseRansacConsensusPercentage()

bool vpXmlConfigParserKeyPoint::getUseRansacConsensusPercentage ( ) const

Get the flag state to choose between a percentage of inliers or a fixed number.

Returns
True to use a percentage value for inliers, false otherwise.

Definition at line 644 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ getUseRansacVVSPoseEstimation()

bool vpXmlConfigParserKeyPoint::getUseRansacVVSPoseEstimation ( ) const

Get the flag state to choose between OpenCV Ransac pose estimation or ViSP Ransac VVS pose estimation.

Returns
True to use ViSP method, false otherwise.

Definition at line 655 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

◆ parse()

void vpXmlConfigParserKeyPoint::parse ( const std::string &  filename)

Parse an XML file to load configuration for vpKeyPoint class.

Parameters
filename: filename of the XML file to parse.

Definition at line 521 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().