Visual Servoing Platform
version 3.0.1
|
#include <visp3/core/vpXmlParserCamera.h>
Public Member Functions | |
vpXmlParserCamera () | |
vpXmlParserCamera (vpXmlParserCamera &twinParser) | |
virtual | ~vpXmlParserCamera () |
std::string | getCameraName () |
vpCameraParameters | getCameraParameters () |
unsigned int | getHeight () |
unsigned int | getSubsampling_width () |
unsigned int | getSubsampling_height () |
unsigned int | getWidth () |
vpXmlParserCamera & | operator= (const vpXmlParserCamera &twinparser) |
int | parse (vpCameraParameters &cam, const std::string &filename, const std::string &camera_name, const vpCameraParameters::vpCameraParametersProjType &projModel, const unsigned int image_width=0, const unsigned int image_height=0) |
int | save (const vpCameraParameters &cam, const std::string &filename, const std::string &camera_name, const unsigned int image_width=0, const unsigned int image_height=0, const std::string &additionalInfo="") |
void | setCameraName (const std::string &name) |
void | setHeight (const unsigned int height) |
void | setSubsampling_width (const unsigned int subsampling) |
void | setSubsampling_height (const unsigned int subsampling) |
void | setWidth (const unsigned int width) |
Public Member Functions Inherited from vpXmlParser | |
void | parse (const std::string &filename) |
void | save (const std::string &filename, const bool append=false) |
void | setMap (const std::map< std::string, int > &_map) |
void | setMainTag (const std::string &tag) |
Static Public Member Functions | |
Static Public Member Functions Inherited from vpXmlParser | |
static void | cleanup () |
Protected Member Functions | |
Protected Member Functions Inherited from vpXmlParser | |
bool | xmlReadBoolChild (xmlDocPtr doc, xmlNodePtr node) |
char * | xmlReadCharChild (xmlDocPtr doc, xmlNodePtr node) |
double | xmlReadDoubleChild (xmlDocPtr doc, xmlNodePtr node) |
float | xmlReadFloatChild (xmlDocPtr doc, xmlNodePtr node) |
int | xmlReadIntChild (xmlDocPtr doc, xmlNodePtr node) |
std::string | xmlReadStringChild (xmlDocPtr doc, xmlNodePtr node) |
unsigned int | xmlReadUnsignedIntChild (xmlDocPtr doc, xmlNodePtr node) |
void | xmlWriteBoolChild (xmlNodePtr node, const char *label, const bool value) |
void | xmlWriteCharChild (xmlNodePtr node, const char *label, const char *value) |
void | xmlWriteDoubleChild (xmlNodePtr node, const char *label, const double value) |
void | xmlWriteFloatChild (xmlNodePtr node, const char *label, const float value) |
void | xmlWriteIntChild (xmlNodePtr node, const char *label, const int value) |
void | xmlWriteStringChild (xmlNodePtr node, const char *label, const std::string &value) |
void | xmlWriteUnsignedIntChild (xmlNodePtr node, const char *label, const unsigned int value) |
Protected Attributes | |
std::map< std::string, int > | nodeMap |
std::string | main_tag |
XML parser to load and save intrinsic camera parameters.
To have a complete description of the camera parameters and the corresponding projection model implemented in ViSP, see vpCameraParameters.
Example of an XML file "myXmlFile.xml" containing intrinsic camera parameters:
Example of loading existing camera parameters from an XML file:
Example of writing an XML file containing intrinsic camera parameters:
Definition at line 188 of file vpXmlParserCamera.h.
Enumerator | |
---|---|
SEQUENCE_OK | |
SEQUENCE_ERROR |
Definition at line 217 of file vpXmlParserCamera.h.
Definition at line 194 of file vpXmlParserCamera.h.
vpXmlParserCamera::vpXmlParserCamera | ( | ) |
Default constructor
Definition at line 81 of file vpXmlParserCamera.cpp.
vpXmlParserCamera::vpXmlParserCamera | ( | vpXmlParserCamera & | twinParser | ) |
Copy constructor
twinParser | : parser object to copy |
Definition at line 91 of file vpXmlParserCamera.cpp.
|
inlinevirtual |
Default destructor.
Definition at line 242 of file vpXmlParserCamera.h.
|
inlinestaticinherited |
As stated in http://xmlsoft.org/html/libxml-parser.html#xmlCleanupParser to clean up memory allocated by the xml2 library itself, the user should call xmlCleanupParser() only when the process has finished using the xml2 library. In case of doubt abstain from calling this function or do it just before calling exit() to avoid leak reports from valgrind ! That's why in ViSP the destructor doesn't call xmlCleanupParser(). Rather we provide the static function vpXmlParser::cleanup() that calls xmlCleanupParser() that could be called just before exit().
Definition at line 308 of file vpXmlParser.h.
|
inline |
Definition at line 245 of file vpXmlParserCamera.h.
|
inline |
Definition at line 246 of file vpXmlParserCamera.h.
|
inline |
Definition at line 247 of file vpXmlParserCamera.h.
|
inline |
Definition at line 249 of file vpXmlParserCamera.h.
|
inline |
Definition at line 248 of file vpXmlParserCamera.h.
|
inline |
Definition at line 250 of file vpXmlParserCamera.h.
vpXmlParserCamera & vpXmlParserCamera::operator= | ( | const vpXmlParserCamera & | twinParser | ) |
Copy operator
twinParser | : parser object to copy |
Definition at line 113 of file vpXmlParserCamera.cpp.
|
inherited |
parse the document. The data in the file are stored in the attributes of the child class. This method calls the readMainClass method which has to be implemented for every child class depending on the content to parse.
filename | : name of the file to parse |
Definition at line 436 of file vpXmlParser.cpp.
References vpException::ioError, vpXmlParser::readMainClass(), and vpERROR_TRACE.
Referenced by vpMbtEdgeKltXmlParser::parse(), vpMbtXmlParser::parse(), vpMbtKltXmlParser::parse(), vpMbXmlParser::parse(), and vpXmlConfigParserKeyPoint::parse().
int vpXmlParserCamera::parse | ( | vpCameraParameters & | cam, |
const std::string & | filename, | ||
const std::string & | cam_name, | ||
const vpCameraParameters::vpCameraParametersProjType & | projModel, | ||
const unsigned int | im_width = 0 , |
||
const unsigned int | im_height = 0 |
||
) |
Parse an xml file to load camera parameters.
cam | : camera parameters to fill. |
filename | : name of the xml file to parse |
cam_name | : name of the camera : useful if the xml file has multiple camera parameters. Set as "" if the camera name is not ambiguous. |
projModel | : camera projection model needed. |
im_width | : image width on which camera calibration was performed. Set as 0 if not ambiguous. |
im_height | : image height on which camera calibration was performed. Set as 0 if not ambiguous. |
Definition at line 140 of file vpXmlParserCamera.cpp.
References SEQUENCE_ERROR.
Referenced by vpViper650::getCameraParameters(), vpViper850::getCameraParameters(), vpAfma6::getCameraParameters(), and vpKinect::start().
|
inherited |
Save the content of the class in the file given in parameters. The data of the class are in the child class. This method calls the write_main_class method which has to be implemented for every class depending on the data to save.
filename | : the name of the file used to record the data |
append | : if true and if the file exists, the data will be added to the data already in the file |
Definition at line 469 of file vpXmlParser.cpp.
References vpException::ioError, vpXmlParser::main_tag, vpERROR_TRACE, and vpXmlParser::writeMainClass().
int vpXmlParserCamera::save | ( | const vpCameraParameters & | cam, |
const std::string & | filename, | ||
const std::string & | cam_name, | ||
const unsigned int | im_width = 0 , |
||
const unsigned int | im_height = 0 , |
||
const std::string & | additionalInfo = "" |
||
) |
Save camera parameters in an xml file.
cam | : camera parameters to save. |
filename | : name of the xml file to fill. |
cam_name | : name of the camera : useful if the xml file has multiple camera parameters. Set as "" if the camera name is not ambiguous. |
im_width | : width of image on which camera calibration was performed. Set as 0 if not ambiguous. |
im_height | : height of the image on which camera calibration was performed. Set as 0 if not ambiguous. |
additionalInfo | : Additional information added in the saved xml file. The content of this string should be in xml format. |
A typical usage would be the following:
In camera.xml
file, you will see:
Definition at line 215 of file vpXmlParserCamera.cpp.
References vpCameraParameters::get_projModel(), SEQUENCE_ERROR, and SEQUENCE_OK.
|
inline |
Definition at line 264 of file vpXmlParserCamera.h.
|
inline |
Definition at line 267 of file vpXmlParserCamera.h.
|
inlineinherited |
set the name of the main tag
The main tag corresponds to the name of the root node
tag | : name of the root node of the document |
Definition at line 293 of file vpXmlParser.h.
Referenced by vpMbXmlParser::init().
|
inlineinherited |
Set the map describing the data to parse. This map stores the name of each node and an associated key used to simplify the parsing of the file.
If the following file want to be parsed:
The following map has to be declared:
Or, you can use keyzord instead of number as key but it implies to declare in the child class an enumeration type of the name. For example:
_map | : the map describing the data to parse |
Definition at line 284 of file vpXmlParser.h.
|
inline |
Definition at line 271 of file vpXmlParserCamera.h.
|
inline |
Definition at line 268 of file vpXmlParserCamera.h.
|
inline |
Definition at line 274 of file vpXmlParserCamera.h.
|
protectedinherited |
read a boolean
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 289 of file vpXmlParser.cpp.
References vpException::fatalError.
|
protectedinherited |
Read an array of character.
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 106 of file vpXmlParser.cpp.
References vpException::fatalError.
|
protectedinherited |
read a double
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 219 of file vpXmlParser.cpp.
References vpException::fatalError, and vpException::ioError.
Referenced by vpMbXmlParser::read_camera(), vpMbtXmlParser::read_contrast(), vpMbXmlParser::read_face(), vpMbtKltXmlParser::read_klt(), and vpMbXmlParser::read_lod().
|
protectedinherited |
read a float
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 252 of file vpXmlParser.cpp.
References vpException::fatalError, and vpException::ioError.
|
protectedinherited |
read an int
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 151 of file vpXmlParser.cpp.
References vpException::fatalError, and vpException::ioError.
Referenced by vpMbXmlParser::read_face(), vpMbXmlParser::read_lod(), vpMbtXmlParser::read_sample(), and vpMbtXmlParser::read_sample_deprecated().
|
protectedinherited |
Read an array of character.
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 127 of file vpXmlParser.cpp.
References vpException::fatalError.
|
protectedinherited |
read an int
doc | : The main xml document |
node | : a pointer to the node to read value |
Definition at line 185 of file vpXmlParser.cpp.
References vpException::fatalError, and vpException::ioError.
Referenced by vpMbtKltXmlParser::read_klt(), vpMbtXmlParser::read_mask(), and vpMbtXmlParser::read_range().
|
protectedinherited |
write a bool.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : boolean to write (true or false) |
Definition at line 414 of file vpXmlParser.cpp.
|
protectedinherited |
write an array of character.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : pointer to the array of character to write |
Definition at line 314 of file vpXmlParser.cpp.
|
protectedinherited |
write a double.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : double to write |
Definition at line 380 of file vpXmlParser.cpp.
|
protectedinherited |
write a float.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : float to write |
Definition at line 397 of file vpXmlParser.cpp.
|
protectedinherited |
write an integer.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : integer to write |
Definition at line 345 of file vpXmlParser.cpp.
|
protectedinherited |
write an array of character.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : std::string to write; |
Definition at line 329 of file vpXmlParser.cpp.
|
protectedinherited |
write an unsigned integer.
node | : a pointer to the node to read value |
label | : label (name of the data) of the node |
value | : unsigned integer to write |
Definition at line 362 of file vpXmlParser.cpp.
|
protectedinherited |
The name of the main tag for the file to parse
Definition at line 229 of file vpXmlParser.h.
Referenced by vpXmlParser::save(), and vpXmlParser::vpXmlParser().
|
protectedinherited |
The map describing the data to parse
Definition at line 224 of file vpXmlParser.h.
Referenced by vpMbtEdgeKltXmlParser::init(), vpMbtXmlParser::init(), vpMbtKltXmlParser::init(), vpMbXmlParser::init(), vpMbXmlParser::read_camera(), vpMbtXmlParser::read_contrast(), vpMbtXmlParser::read_ecm(), vpMbXmlParser::read_face(), vpMbtKltXmlParser::read_klt(), vpMbXmlParser::read_lod(), vpMbtXmlParser::read_mask(), vpMbtXmlParser::read_range(), vpMbtXmlParser::read_sample(), vpMbtXmlParser::read_sample_deprecated(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), vpMbXmlParser::readMainClass(), and vpXmlParser::vpXmlParser().