Visual Servoing Platform
version 3.1.0
|
#include <visp3/vision/vpXmlConfigParserKeyPoint.h>
Public Member Functions | |
vpXmlConfigParserKeyPoint () | |
virtual | ~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) |
Public Member Functions Inherited from vpXmlParser | |
void | save (const std::string &filename, const bool append=false) |
void | setMap (const std::map< std::string, int > &_map) |
void | setMainTag (const std::string &tag) |
Static Public Member Functions | |
Static Public Member Functions Inherited from vpXmlParser | |
static void | cleanup () |
Protected Member Functions | |
Protected Member Functions Inherited from vpXmlParser | |
bool | xmlReadBoolChild (xmlDocPtr doc, xmlNodePtr node) |
char * | xmlReadCharChild (xmlDocPtr doc, xmlNodePtr node) |
double | xmlReadDoubleChild (xmlDocPtr doc, xmlNodePtr node) |
float | xmlReadFloatChild (xmlDocPtr doc, xmlNodePtr node) |
int | xmlReadIntChild (xmlDocPtr doc, xmlNodePtr node) |
std::string | xmlReadStringChild (xmlDocPtr doc, xmlNodePtr node) |
unsigned int | xmlReadUnsignedIntChild (xmlDocPtr doc, xmlNodePtr node) |
void | xmlWriteBoolChild (xmlNodePtr node, const char *label, const bool value) |
void | xmlWriteCharChild (xmlNodePtr node, const char *label, const char *value) |
void | xmlWriteDoubleChild (xmlNodePtr node, const char *label, const double value) |
void | xmlWriteFloatChild (xmlNodePtr node, const char *label, const float value) |
void | xmlWriteIntChild (xmlNodePtr node, const char *label, const int value) |
void | xmlWriteStringChild (xmlNodePtr node, const char *label, const std::string &value) |
void | xmlWriteUnsignedIntChild (xmlNodePtr node, const char *label, const unsigned int value) |
Protected Attributes | |
std::map< std::string, int > | nodeMap |
std::string | main_tag |
Definition at line 70 of file vpXmlConfigParserKeyPoint.h.
Enumerator for the different filtering matching method.
Definition at line 116 of file vpXmlConfigParserKeyPoint.h.
Predefined xml node identifier.
Definition at line 75 of file vpXmlConfigParserKeyPoint.h.
vpXmlConfigParserKeyPoint::vpXmlConfigParserKeyPoint | ( | ) |
Definition at line 53 of file vpXmlConfigParserKeyPoint.cpp.
References conf, constant_factor_distance_threshold, detector, extractor, matcher, matching_factor_threshold, matching_method, matching_ratio_threshold, name, nb_ransac_iterations, nb_ransac_min_inlier_count, no_filter_matching, vpXmlParser::nodeMap, ransac, ransac_consensus_percentage, ransac_reprojection_error, ransac_threshold, ratio_distance_threshold, vpXmlParser::setMainTag(), std_and_ratio_distance_threshold, std_distance_threshold, use_ransac_consensus_percentage, and use_ransac_vvs.
|
inlinevirtual |
Default destructor.
Definition at line 163 of file vpXmlConfigParserKeyPoint.h.
|
inlinestaticinherited |
As stated in http://xmlsoft.org/html/libxml-parser.html#xmlCleanupParser to clean up memory allocated by the xml2 library itself, the user should call xmlCleanupParser() only when the process has finished using the xml2 library. In case of doubt abstain from calling this function or do it just before calling exit() to avoid leak reports from valgrind ! That's why in ViSP the destructor doesn't call xmlCleanupParser(). Rather we provide the static function vpXmlParser::cleanup() that calls xmlCleanupParser() that could be called just before exit().
Definition at line 310 of file vpXmlParser.h.
|
inline |
Get the detector name.
Definition at line 170 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the extractor name.
Definition at line 177 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the matcher name.
Definition at line 183 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the factor value.
Definition at line 190 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the filtering method.
Definition at line 197 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the ratio value.
Definition at line 204 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the maximum number of iterations for the Ransac method.
Definition at line 211 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the minimum number of inliers for the Ransac method.
Definition at line 218 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the percentage value of inliers for the Ransac method.
Definition at line 225 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the maximum reprojection error for a candidate inlier for the Ransac method.
Definition at line 233 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the maximum error for a candidate inlier for the Ransac method.
Definition at line 240 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the flag state to choose between a percentage of inliers or a fixed number.
Definition at line 248 of file vpXmlConfigParserKeyPoint.h.
Referenced by vpKeyPoint::loadConfigFile().
|
inline |
Get the flag state to choose between OpenCV Ransac pose estimation or ViSP Ransac VVS pose estimation.
Definition at line 256 of file vpXmlConfigParserKeyPoint.h.
References vpXmlParser::parse(), vpXmlParser::readMainClass(), and vpXmlParser::writeMainClass().
Referenced by vpKeyPoint::loadConfigFile().
void vpXmlConfigParserKeyPoint::parse | ( | const std::string & | filename | ) |
Parse an XML file to get configuration value for vpKeyPoint class.
filename | : filename of the XML file to parse |
Parse an XML file to load configuration for vpKeyPoint class.
filename | : filename of the XML file to parse. |
Definition at line 96 of file vpXmlConfigParserKeyPoint.cpp.
References constant_factor_distance_threshold, constantFactorDistanceThreshold, detector, extractor, matcher, matching_factor_threshold, matching_method, matching_ratio_threshold, name, nb_ransac_iterations, nb_ransac_min_inlier_count, no_filter_matching, vpXmlParser::nodeMap, noFilterMatching, vpXmlParser::parse(), ransac, ransac_consensus_percentage, ransac_reprojection_error, ransac_threshold, ratio_distance_threshold, ratioDistanceThreshold, std_and_ratio_distance_threshold, std_distance_threshold, stdAndRatioDistanceThreshold, stdDistanceThreshold, use_ransac_consensus_percentage, use_ransac_vvs, vpXmlParser::xmlReadDoubleChild(), vpXmlParser::xmlReadIntChild(), and vpXmlParser::xmlReadStringChild().
Referenced by vpKeyPoint::loadConfigFile().
|
inherited |
Save the content of the class in the file given in parameters. The data of the class are in the child class. This method calls the write_main_class method which has to be implemented for every class depending on the data to save.
filename | : the name of the file used to record the data |
append | : if true and if the file exists, the data will be added to the data already in the file |
Definition at line 453 of file vpXmlParser.cpp.
References vpException::ioError, vpXmlParser::main_tag, vpERROR_TRACE, and vpXmlParser::writeMainClass().
Referenced by vpXmlParserHomogeneousMatrix::getHomogeneousMatrixName(), and vpXmlParserCamera::getWidth().
|
inlineinherited |
set the name of the main tag
The main tag corresponds to the name of the root node
tag | : name of the root node of the document |
Definition at line 295 of file vpXmlParser.h.
Referenced by vpMbXmlParser::init(), vpMbtXmlGenericParser::init(), and vpXmlConfigParserKeyPoint().
|
inlineinherited |
Set the map describing the data to parse. This map stores the name of each node and an associated key used to simplify the parsing of the file.
If the following file want to be parsed:
The following map has to be declared:
Or, you can use keyzord instead of number as key but it implies to declare in the child class an enumeration type of the name. For example:
_map | : the map describing the data to parse |
Definition at line 286 of file vpXmlParser.h.
|
protectedinherited |
read a boolean
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 282 of file vpXmlParser.cpp.
References vpException::fatalError.
|
protectedinherited |
Read an array of character.
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 100 of file vpXmlParser.cpp.
References vpException::fatalError.
Referenced by vpXmlParserHomogeneousMatrix::save(), and vpXmlParserCamera::save().
|
protectedinherited |
read a double
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 212 of file vpXmlParser.cpp.
References vpException::fatalError, and vpException::ioError.
Referenced by parse(), vpMbXmlParser::read_camera(), vpMbtXmlGenericParser::read_camera(), vpMbtXmlParser::read_contrast(), vpMbtXmlGenericParser::read_depth_normal_PCL(), vpMbtXmlGenericParser::read_ecm_contrast(), vpMbXmlParser::read_face(), vpMbtXmlGenericParser::read_face(), vpMbtKltXmlParser::read_klt(), vpMbtXmlGenericParser::read_klt(), vpMbXmlParser::read_lod(), vpMbtXmlGenericParser::read_lod(), vpXmlParserHomogeneousMatrix::save(), and vpXmlParserCamera::save().
|
protectedinherited |
read a float
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 245 of file vpXmlParser.cpp.
References vpException::fatalError, and vpException::ioError.
|
protectedinherited |
read an int
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 144 of file vpXmlParser.cpp.
References vpException::fatalError, and vpException::ioError.
Referenced by parse(), vpMbtXmlGenericParser::read_depth_normal(), vpMbtXmlGenericParser::read_depth_normal_PCL(), vpMbtXmlGenericParser::read_ecm_sample(), vpMbXmlParser::read_face(), vpMbtXmlGenericParser::read_face(), vpMbXmlParser::read_lod(), vpMbtXmlGenericParser::read_lod(), vpMbtXmlParser::read_sample(), vpMbtXmlParser::read_sample_deprecated(), and vpMbtXmlGenericParser::read_sample_deprecated().
|
protectedinherited |
Read an array of character.
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 120 of file vpXmlParser.cpp.
References vpException::fatalError.
Referenced by parse().
|
protectedinherited |
read an int
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 178 of file vpXmlParser.cpp.
References vpException::fatalError, and vpException::ioError.
Referenced by vpMbtXmlGenericParser::read_depth_dense_sampling_step(), vpMbtXmlGenericParser::read_depth_normal_sampling_step(), vpMbtXmlGenericParser::read_ecm_mask(), vpMbtXmlGenericParser::read_ecm_range(), vpMbtKltXmlParser::read_klt(), vpMbtXmlGenericParser::read_klt(), vpMbtXmlParser::read_mask(), vpMbtXmlParser::read_range(), and vpXmlParserCamera::save().
|
protectedinherited |
write a bool.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : boolean to write (true or false) |
Definition at line 398 of file vpXmlParser.cpp.
|
protectedinherited |
write an array of character.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : pointer to the array of character to write |
Definition at line 306 of file vpXmlParser.cpp.
|
protectedinherited |
write a double.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : double to write |
Definition at line 366 of file vpXmlParser.cpp.
|
protectedinherited |
write a float.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : float to write |
Definition at line 382 of file vpXmlParser.cpp.
|
protectedinherited |
write an integer.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : integer to write |
Definition at line 334 of file vpXmlParser.cpp.
|
protectedinherited |
write an array of character.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : std::string to write; |
Definition at line 320 of file vpXmlParser.cpp.
|
protectedinherited |
write an unsigned integer.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : unsigned integer to write |
Definition at line 350 of file vpXmlParser.cpp.
|
protectedinherited |
The name of the main tag for the file to parse
Definition at line 231 of file vpXmlParser.h.
Referenced by vpXmlParser::save().
|
protectedinherited |
The map describing the data to parse
Definition at line 226 of file vpXmlParser.h.
Referenced by vpMbtEdgeKltXmlParser::init(), vpMbtXmlParser::init(), vpMbtKltXmlParser::init(), vpMbXmlParser::init(), vpMbtXmlGenericParser::init(), parse(), vpMbXmlParser::read_camera(), vpMbtXmlGenericParser::read_camera(), vpMbtXmlParser::read_contrast(), vpMbtXmlGenericParser::read_depth_dense(), vpMbtXmlGenericParser::read_depth_dense_sampling_step(), vpMbtXmlGenericParser::read_depth_normal(), vpMbtXmlGenericParser::read_depth_normal_PCL(), vpMbtXmlGenericParser::read_depth_normal_sampling_step(), vpMbtXmlParser::read_ecm(), vpMbtXmlGenericParser::read_ecm(), vpMbtXmlGenericParser::read_ecm_contrast(), vpMbtXmlGenericParser::read_ecm_mask(), vpMbtXmlGenericParser::read_ecm_range(), vpMbtXmlGenericParser::read_ecm_sample(), vpMbXmlParser::read_face(), vpMbtXmlGenericParser::read_face(), vpMbtKltXmlParser::read_klt(), vpMbtXmlGenericParser::read_klt(), vpMbXmlParser::read_lod(), vpMbtXmlGenericParser::read_lod(), vpMbtXmlParser::read_mask(), vpMbtXmlParser::read_range(), vpMbtXmlParser::read_sample(), vpMbtXmlParser::read_sample_deprecated(), vpMbtXmlGenericParser::read_sample_deprecated(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), vpMbXmlParser::readMainClass(), vpMbtXmlGenericParser::readMainClass(), and vpXmlConfigParserKeyPoint().