Visual Servoing Platform  version 3.6.1 under development (2024-11-14)
vpXmlParserCamera.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2024 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 VP_XML_PARSER_CAMERA_H
42 #define VP_XML_PARSER_CAMERA_H
43 
44 #include <visp3/core/vpConfig.h>
45 
46 #if defined(VISP_HAVE_PUGIXML)
47 #include <visp3/core/vpCameraParameters.h>
48 
49 BEGIN_VISP_NAMESPACE
172 class VISP_EXPORT vpXmlParserCamera
173 {
174 public:
175  enum vpXmlCodeSequenceType { SEQUENCE_OK, SEQUENCE_ERROR };
176 
179 
180  // get/set functions
181  std::string getCameraName() const;
182  vpCameraParameters getCameraParameters() const;
183  unsigned int getHeight() const;
184  unsigned int getSubsampling_width() const;
185  unsigned int getSubsampling_height() const;
186  unsigned int getWidth() const;
187 
188  int parse(vpCameraParameters &cam, const std::string &filename, const std::string &camera_name,
189  const vpCameraParameters::vpCameraParametersProjType &projModel, unsigned int image_width = 0,
190  unsigned int image_height = 0, bool verbose = true);
191 
192  int save(const vpCameraParameters &cam, const std::string &filename, const std::string &camera_name,
193  unsigned int image_width = 0, unsigned int image_height = 0, const std::string &additionalInfo = "",
194  bool verbose = true);
195 
196  void setCameraName(const std::string &name);
197  void setHeight(unsigned int height);
198  void setSubsampling_width(unsigned int subsampling);
199  void setSubsampling_height(unsigned int subsampling);
200  void setWidth(unsigned int width);
201 
202 private:
203  vpXmlParserCamera(const vpXmlParserCamera &c); // noncopyable
204  vpXmlParserCamera &operator=(const vpXmlParserCamera &c); //
205 
206  // PIMPL idiom
207  class Impl;
208  Impl *m_impl;
209 };
210 END_VISP_NAMESPACE
211 #endif
212 #endif
Generic class defining intrinsic camera parameters.
XML parser to load and save intrinsic camera parameters.