Visual Servoing Platform  version 3.6.1 under development (2024-05-27)
vpXmlConfigParserKeyPoint.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2023 by Inria. All rights reserved.
4  *
5  * This software is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ViSP with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * See https://visp.inria.fr for more information.
17  *
18  * This software was developed at:
19  * Inria Rennes - Bretagne Atlantique
20  * Campus Universitaire de Beaulieu
21  * 35042 Rennes Cedex
22  * France
23  *
24  * If you have questions regarding the use of this file, please contact
25  * Inria at visp@inria.fr
26  *
27  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
28  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
29  *
30  * Description:
31  * XML parser to load configuration for vpKeyPoint class.
32  */
33 
42 #ifndef _vpXmlConfigParserKeyPoint_h_
43 #define _vpXmlConfigParserKeyPoint_h_
44 
45 #include <visp3/core/vpConfig.h>
46 
47 #if defined(VISP_HAVE_PUGIXML)
48 #include <string>
49 
59 class VISP_EXPORT vpXmlConfigParserKeyPoint
60 {
61 public:
64  {
65  constantFactorDistanceThreshold,
67  stdDistanceThreshold,
70  stdAndRatioDistanceThreshold,
72  noFilterMatching
73  };
74 
79 
84 
90  std::string getDetectorName() const;
91 
97  std::string getExtractorName() const;
98 
104  std::string getMatcherName() const;
105 
111  double getMatchingFactorThreshold() const;
112 
118  vpMatchingMethodEnum getMatchingMethod() const;
119 
125  double getMatchingRatioThreshold() const;
126 
132  int getNbRansacIterations() const;
133 
139  int getNbRansacMinInlierCount() const;
140 
146  double getRansacConsensusPercentage() const;
147 
154  double getRansacReprojectionError() const;
155 
161  double getRansacThreshold() const;
162 
169  bool getUseRansacConsensusPercentage() const;
170 
177  bool getUseRansacVVSPoseEstimation() const;
178 
183  void parse(const std::string &filename);
184 
185 private:
190 
195 
197  class Impl;
199  Impl *m_impl;
200 };
201 #endif
202 #endif