Visual Servoing Platform  version 3.6.1 under development (2024-12-09)
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 
50 BEGIN_VISP_NAMESPACE
60 class VISP_EXPORT vpXmlConfigParserKeyPoint
61 {
62 public:
65  {
66  constantFactorDistanceThreshold,
68  stdDistanceThreshold,
71  stdAndRatioDistanceThreshold,
73  noFilterMatching
74  };
75 
80 
85 
91  std::string getDetectorName() const;
92 
98  std::string getExtractorName() const;
99 
105  std::string getMatcherName() const;
106 
112  double getMatchingFactorThreshold() const;
113 
119  vpMatchingMethodEnum getMatchingMethod() const;
120 
126  double getMatchingRatioThreshold() const;
127 
133  int getNbRansacIterations() const;
134 
140  int getNbRansacMinInlierCount() const;
141 
147  double getRansacConsensusPercentage() const;
148 
155  double getRansacReprojectionError() const;
156 
162  double getRansacThreshold() const;
163 
170  bool getUseRansacConsensusPercentage() const;
171 
178  bool getUseRansacVVSPoseEstimation() const;
179 
184  void parse(const std::string &filename);
185 
186 private:
191 
196 
198  class Impl;
200  Impl *m_impl;
201 };
202 END_VISP_NAMESPACE
203 #endif
204 #endif