vpXmlConfigParserKeyPoint Class Reference

#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

Class vpXmlConfigParserKeyPoint allows to load configuration defined in a XML file for vpKeyPoint class.

Warning

This class is only available if pugixml is successfully built.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 60 of file vpXmlConfigParserKeyPoint.h.

Member Enumeration Documentation

vpMatchingMethodEnum

enum vpXmlConfigParserKeyPoint::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 64 of file vpXmlConfigParserKeyPoint.h.

Constructor & Destructor Documentation

vpXmlConfigParserKeyPoint()

BEGIN_VISP_NAMESPACE vpXmlConfigParserKeyPoint::vpXmlConfigParserKeyPoint

(

)

Default constructor.

Definition at line 507 of file vpXmlConfigParserKeyPoint.cpp.

~vpXmlConfigParserKeyPoint()

vpXmlConfigParserKeyPoint::~vpXmlConfigParserKeyPoint

(

)

Default destructor.

Definition at line 509 of file vpXmlConfigParserKeyPoint.cpp.

Member Function Documentation

getDetectorName()

std::string vpXmlConfigParserKeyPoint::getDetectorName

(

)

const

Get the detector name.

Returns

The detector name.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 513 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

getExtractorName()

std::string vpXmlConfigParserKeyPoint::getExtractorName

(

)

const

Get the extractor name.

Returns

The extractor name.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 515 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

getMatcherName()

std::string vpXmlConfigParserKeyPoint::getMatcherName

(

)

const

Get the matcher name.

Returns

The detector name.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 517 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 519 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().

getMatchingMethod()

vpXmlConfigParserKeyPoint::vpMatchingMethodEnum vpXmlConfigParserKeyPoint::getMatchingMethod

(

)

const

Get the filtering method.

Returns

The filtering method.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 521 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.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 526 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.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 528 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 530 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.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 532 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 537 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.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 539 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.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 541 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.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 546 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.

Examples

testXmlConfigParserKeyPoint.cpp.

Definition at line 511 of file vpXmlConfigParserKeyPoint.cpp.

Referenced by vpKeyPoint::loadConfigFile().