Visual Servoing Platform  version 3.6.1 under development (2023-11-30)
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 #include <string>
48 
58 class VISP_EXPORT vpXmlConfigParserKeyPoint
59 {
60 public:
63  {
64  constantFactorDistanceThreshold,
66  stdDistanceThreshold,
69  stdAndRatioDistanceThreshold,
71  noFilterMatching
72  };
73 
78 
83 
89  std::string getDetectorName() const;
90 
96  std::string getExtractorName() const;
97 
103  std::string getMatcherName() const;
104 
110  double getMatchingFactorThreshold() const;
111 
117  vpMatchingMethodEnum getMatchingMethod() const;
118 
124  double getMatchingRatioThreshold() const;
125 
131  int getNbRansacIterations() const;
132 
138  int getNbRansacMinInlierCount() const;
139 
145  double getRansacConsensusPercentage() const;
146 
153  double getRansacReprojectionError() const;
154 
160  double getRansacThreshold() const;
161 
168  bool getUseRansacConsensusPercentage() const;
169 
176  bool getUseRansacVVSPoseEstimation() const;
177 
182  void parse(const std::string &filename);
183 
184 private:
189 
194 
196  class Impl;
198  Impl *m_impl;
199 };
200 #endif