Visual Servoing Platform  version 3.6.1 under development (2024-04-22)
vpXmlParserCamera.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 and save camera intrinsic parameters.
32  */
33 
41 #ifndef vpXMLPARSERCAMERA_H
42 #define vpXMLPARSERCAMERA_H
43 
44 #include <visp3/core/vpConfig.h>
45 
46 #if defined(VISP_HAVE_PUGIXML)
47 #include <visp3/core/vpCameraParameters.h>
48 
163 class VISP_EXPORT vpXmlParserCamera
164 {
165 public:
166  enum vpXmlCodeSequenceType { SEQUENCE_OK, SEQUENCE_ERROR };
167 
170 
171  // get/set functions
172  std::string getCameraName() const;
173  vpCameraParameters getCameraParameters() const;
174  unsigned int getHeight() const;
175  unsigned int getSubsampling_width() const;
176  unsigned int getSubsampling_height() const;
177  unsigned int getWidth() const;
178 
179  int parse(vpCameraParameters &cam, const std::string &filename, const std::string &camera_name,
180  const vpCameraParameters::vpCameraParametersProjType &projModel, unsigned int image_width = 0,
181  unsigned int image_height = 0, bool verbose = true);
182 
183  int save(const vpCameraParameters &cam, const std::string &filename, const std::string &camera_name,
184  unsigned int image_width = 0, unsigned int image_height = 0, const std::string &additionalInfo = "",
185  bool verbose = true);
186 
187  void setCameraName(const std::string &name);
188  void setHeight(unsigned int height);
189  void setSubsampling_width(unsigned int subsampling);
190  void setSubsampling_height(unsigned int subsampling);
191  void setWidth(unsigned int width);
192 
193 private:
194  vpXmlParserCamera(const vpXmlParserCamera &); // noncopyable
195  vpXmlParserCamera &operator=(const vpXmlParserCamera &); //
196 
197  // PIMPL idiom
198  class Impl;
199  Impl *m_impl;
200 };
201 #endif
202 #endif
Generic class defining intrinsic camera parameters.
XML parser to load and save intrinsic camera parameters.