vpXmlConfigParserKeyPoint.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * XML parser to load configuration for vpKeyPoint class.
 */

 
#ifndef _vpXmlConfigParserKeyPoint_h_
#define _vpXmlConfigParserKeyPoint_h_
 
#include <visp3/core/vpConfig.h>
 
#if defined(VISP_HAVE_PUGIXML)
#include <string>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpXmlConfigParserKeyPoint
{
public:
  enum vpMatchingMethodEnum
  {
    constantFactorDistanceThreshold, 
    stdDistanceThreshold,            
    ratioDistanceThreshold,          
    stdAndRatioDistanceThreshold,    
    noFilterMatching                 
  };

  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);
 
private:
  vpXmlConfigParserKeyPoint(const vpXmlConfigParserKeyPoint &);

  vpXmlConfigParserKeyPoint &operator=(const vpXmlConfigParserKeyPoint &);

  class Impl;
  Impl *m_impl;
};
END_VISP_NAMESPACE
#endif
#endif