vpMbXmlParser Class Reference

#include <vpMbXmlParser.h>

Inheritance diagram for vpMbXmlParser:

Collaboration diagram for vpMbXmlParser:

Public Member Functions
	vpMbXmlParser ()
virtual	~vpMbXmlParser ()
double	getAngleAppear () const
double	getAngleDisappear () const
void	getCameraParameters (vpCameraParameters &_cam) const
double	getFarClippingDistance () const
bool	getFovClipping () const
double	getNearClippingDistance () const
bool	hasFarClippingDistance () const
bool	hasNearClippingDistance () const
void	parse (const char *filename)
virtual void	readMainClass (xmlDocPtr doc, xmlNodePtr node)
void	read_camera (xmlDocPtr doc, xmlNodePtr node)
void	read_face (xmlDocPtr doc, xmlNodePtr node)
void	setAngleAppear (const double &aappear)
void	setAngleDisappear (const double &adisappear)
void	setCameraParameters (const vpCameraParameters &_cam)
void	setFarClippingDistance (const double &fclip)
void	setNearClippingDistance (const double &nclip)
void	writeMainClass (xmlNodePtr node)
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 void	cleanup ()

Protected Types
enum	dataToParseMb {   conf, face, angle_appear, angle_disappear,   near_clipping, far_clipping, fov_clipping, camera,   height, width, u0, v0,   px, py, last }

Protected Member Functions
void	init ()
std::string	xmlReadStringChild (xmlDocPtr doc, xmlNodePtr node)
char *	xmlReadCharChild (xmlDocPtr doc, xmlNodePtr node)
int	xmlReadIntChild (xmlDocPtr doc, xmlNodePtr node)
unsigned int	xmlReadUnsignedIntChild (xmlDocPtr doc, xmlNodePtr node)
double	xmlReadDoubleChild (xmlDocPtr doc, xmlNodePtr node)
void	xmlWriteStringChild (xmlNodePtr node, const char *label, const std::string &value)
void	xmlWriteCharChild (xmlNodePtr node, const char *label, const char *value)
void	xmlWriteIntChild (xmlNodePtr node, const char *label, const int value)
void	xmlWriteUnsignedIntChild (xmlNodePtr node, const char *label, const unsigned int value)
void	xmlWriteDoubleChild (xmlNodePtr node, const char *label, const double value)

Protected Attributes
vpCameraParameters	cam
double	angleAppear
double	angleDisappear
bool	hasNearClipping
double	nearClipping
bool	hasFarClipping
double	farClipping
bool	fovClipping
std::map< std::string, int >	nodeMap
std::string	main_tag

Detailed Description

Parse an Xml file to extract configuration parameters of a mbtConfig object.

Data parser for the model based tracker.

Definition at line 67 of file vpMbXmlParser.h.

Member Enumeration Documentation

enum vpMbXmlParser::dataToParseMb

protected

Enumerator
conf
face
angle_appear
angle_disappear
near_clipping
far_clipping
fov_clipping
camera
height
width
u0
v0
px
py
last

Definition at line 87 of file vpMbXmlParser.h.

Constructor & Destructor Documentation

vpMbXmlParser::vpMbXmlParser

(

)

Default constructor.

Definition at line 58 of file vpMbXmlParser.cpp.

References init().

vpMbXmlParser::~vpMbXmlParser ( )

virtual

Default destructor.

Definition at line 70 of file vpMbXmlParser.cpp.

Member Function Documentation

static void vpXmlParser::cleanup ( )

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().

Examples:

mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, testXmlParser.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, and tutorial-mb-klt-tracker.cpp.

Definition at line 220 of file vpXmlParser.h.

double vpMbXmlParser::getAngleAppear ( ) const

inline

Get the angle to determine if a face appeared.

Returns

angleAppear

Definition at line 116 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

double vpMbXmlParser::getAngleDisappear ( ) const

inline

Get the angle to determine if a face disappeared.

Returns

angleDisappear

Definition at line 123 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

void vpMbXmlParser::getCameraParameters ( vpCameraParameters &  _cam ) const

inline

Definition at line 125 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

double vpMbXmlParser::getFarClippingDistance ( ) const

inline

Get the far clipping distance.

Returns

farClipping

Definition at line 132 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

bool vpMbXmlParser::getFovClipping ( ) const

inline

Use FOV clipping

Returns

True if yes, False otherwise.

Definition at line 139 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

double vpMbXmlParser::getNearClippingDistance ( ) const

inline

Get the near clipping distance.

Returns

nearClipping

Definition at line 146 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

bool vpMbXmlParser::hasFarClippingDistance ( ) const

inline

Has Far clipping been specified?

Returns

True if yes, False otherwise.

Definition at line 153 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

bool vpMbXmlParser::hasNearClippingDistance ( ) const

inline

Has Near clipping been specified?

Returns

True if yes, False otherwise.

Definition at line 160 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

void vpMbXmlParser::init ( void  )

protected

Initialise internal variables (including the map).

Definition at line 78 of file vpMbXmlParser.cpp.

References angle_appear, angle_disappear, camera, conf, face, far_clipping, fov_clipping, height, near_clipping, vpXmlParser::nodeMap, px, py, vpXmlParser::setMainTag(), u0, v0, and width.

Referenced by vpMbtXmlParser::init(), vpMbtKltXmlParser::init(), and vpMbXmlParser().

Here is the caller graph for this function:

void vpMbXmlParser::parse

(

const char *

filename

)

Parse the file in parameters. This method is deprecated, use parse() instead.

Parameters

filename

: File to parse.

Definition at line 105 of file vpMbXmlParser.cpp.

References vpXmlParser::parse().

void vpXmlParser::parse ( const std::string &  filename )

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.

Parameters

filename

: name of the file to parse

Definition at line 343 of file vpXmlParser.cpp.

References vpException::ioError, vpXmlParser::readMainClass(), and vpERROR_TRACE.

Referenced by vpMbtEdgeKltXmlParser::parse(), vpMbtXmlParser::parse(), vpMbtKltXmlParser::parse(), and parse().

Here is the caller graph for this function:

void vpMbXmlParser::read_camera	(	xmlDocPtr	doc,
		xmlNodePtr	node
	)

Read camera information.

Exceptions

vpException::fatalError

if there was an unexpected number of data.

Parameters

doc	: Pointer to the document.
node	: Pointer to the node of the camera information.

Definition at line 178 of file vpMbXmlParser.cpp.

References cam, vpCameraParameters::get_px(), vpCameraParameters::get_py(), vpCameraParameters::get_u0(), vpCameraParameters::get_v0(), vpCameraParameters::initPersProjWithoutDistortion(), vpXmlParser::nodeMap, px, py, u0, v0, and vpXmlParser::xmlReadDoubleChild().

Referenced by vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and readMainClass().

Here is the caller graph for this function:

void vpMbXmlParser::read_face	(	xmlDocPtr	doc,
		xmlNodePtr	node
	)

Read face information.

Exceptions

vpException::fatalError

if there was an unexpected number of data.

Parameters

doc	: Pointer to the document.
node	: Pointer to the node of the camera information.

Definition at line 252 of file vpMbXmlParser.cpp.

References angle_appear, angle_disappear, angleAppear, angleDisappear, far_clipping, farClipping, fov_clipping, fovClipping, hasFarClipping, hasNearClipping, near_clipping, nearClipping, vpXmlParser::nodeMap, vpXmlParser::xmlReadDoubleChild(), and vpXmlParser::xmlReadIntChild().

Referenced by vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and readMainClass().

Here is the caller graph for this function:

void vpMbXmlParser::readMainClass ( xmlDocPtr  doc, xmlNodePtr  node  )

virtual

Read the parameters of the class from the file given by its document pointer and by its root node.

Parameters

doc	: Document to parse.
node	: Root node.

Implements vpXmlParser.

Reimplemented in vpMbtKltXmlParser, vpMbtXmlParser, and vpMbtEdgeKltXmlParser.

Definition at line 130 of file vpMbXmlParser.cpp.

References angleAppear, angleDisappear, cam, camera, face, vpCameraParameters::get_px(), vpCameraParameters::get_py(), vpCameraParameters::get_u0(), vpCameraParameters::get_v0(), vpXmlParser::nodeMap, read_camera(), and read_face().

void vpXmlParser::save ( const std::string &  filename, const bool  append = false  )

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.

Parameters

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 376 of file vpXmlParser.cpp.

References vpException::ioError, vpXmlParser::main_tag, vpERROR_TRACE, and vpXmlParser::writeMainClass().

void vpMbXmlParser::setAngleAppear ( const double &  aappear )

inline

Set the angle to determine if a face appeared.

Parameters

aappear

: New angleAppear

Definition at line 173 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

void vpMbXmlParser::setAngleDisappear ( const double &  adisappear )

inline

Set the angle to determine if a face disappeared.

Parameters

adisappear

: New angleDisappear

Definition at line 180 of file vpMbXmlParser.h.

Referenced by vpMbKltTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

void vpMbXmlParser::setCameraParameters ( const vpCameraParameters &  _cam )

inline

Definition at line 182 of file vpMbXmlParser.h.

Referenced by vpMbEdgeKltTracker::loadConfigFile(), and vpMbEdgeTracker::loadConfigFile().

Here is the caller graph for this function:

void vpMbXmlParser::setFarClippingDistance ( const double &  fclip )

inline

Set the far clipping distance.

Parameters

fclip

: New farClipping

Definition at line 189 of file vpMbXmlParser.h.

void vpXmlParser::setMainTag ( const std::string &  tag )

inlineinherited

set the name of the main tag

The main tag corresponds to the name of the root node

Parameters

tag	: name of the root node of the document

Definition at line 280 of file vpXmlParser.h.

Referenced by init().

Here is the caller graph for this function:

void vpXmlParser::setMap ( const std::map< std::string, int > &  _map )

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:

<config>
  <range>5</range>
  <step>7</step>
  <size_filter>3</size_filter>
</config>

The following map has to be declared:

std::map dataToParse;
dataToParse["config"] = 0;
dataToParse["range"] = 1;
dataToParse["step"] = 2;
dataToParse["size_filter"] = 3;

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:

typedef enum{
  config,
  range,
  step,
  size_filter} data_enum;

std::map dataToParse;
dataToParse["config"] = config;
dataToParse["range"] = range;
dataToParse["step"] = step;
dataToParse["size_filter"] = size_filter;

Parameters

_map	: the map describing the data to parse

Definition at line 271 of file vpXmlParser.h.

void vpMbXmlParser::setNearClippingDistance ( const double &  nclip )

inline

Set the near clipping distance.

Parameters

nclip

: New nearClipping

Definition at line 196 of file vpMbXmlParser.h.

void vpMbXmlParser::writeMainClass ( xmlNodePtr  node )

virtual

Write info to file.

Warning

Useless, so not yet implemented => Throw exception.

Implements vpXmlParser.

Definition at line 117 of file vpMbXmlParser.cpp.

References vpException::notImplementedError.

char * vpXmlParser::xmlReadCharChild ( xmlDocPtr  doc, xmlNodePtr  node  )

protectedinherited

Read an array of character.

Warning

The array of characters is allocated and must be explicitly freed to avoid memory leak.

Parameters

doc	: The main xml document
node	: a pointer to the node to read value

Returns

pointer to an allocated array of character.

Definition at line 110 of file vpXmlParser.cpp.

References vpException::fatalError.

double vpXmlParser::xmlReadDoubleChild ( xmlDocPtr  doc, xmlNodePtr  node  )

protectedinherited

read a double

Warning

throw a vpException::ioError if the value cannot be parsed to an integer

Parameters

doc	: The main xml document
node	: a pointer to the node to read value

Returns

the double value in the node

Definition at line 224 of file vpXmlParser.cpp.

References vpException::fatalError, and vpException::ioError.

Referenced by read_camera(), vpMbtXmlParser::read_contrast(), read_face(), and vpMbtKltXmlParser::read_klt().

Here is the caller graph for this function:

int vpXmlParser::xmlReadIntChild ( xmlDocPtr  doc, xmlNodePtr  node  )

protectedinherited

read an int

Warning

throw a vpException::ioError if the value cannot be parsed to an integer

Parameters

doc	: The main xml document
node	: a pointer to the node to read value

Returns

the integer value in the node

Definition at line 155 of file vpXmlParser.cpp.

References vpException::fatalError, and vpException::ioError.

Referenced by read_face(), and vpMbtXmlParser::read_sample().

Here is the caller graph for this function:

std::string vpXmlParser::xmlReadStringChild ( xmlDocPtr  doc, xmlNodePtr  node  )

protectedinherited

Read an array of character.

Parameters

doc	: The main xml document
node	: a pointer to the node to read value

Returns

std::string representing the value.

Definition at line 131 of file vpXmlParser.cpp.

References vpException::fatalError.

unsigned int vpXmlParser::xmlReadUnsignedIntChild ( xmlDocPtr  doc, xmlNodePtr  node  )

protectedinherited

read an int

Warning

throw a vpException::ioError if the value cannot be parsed to an integer

Parameters

doc	: The main xml document
node	: a pointer to the node to read value

Returns

the unsigned integer value in the node

Definition at line 189 of file vpXmlParser.cpp.

References vpException::fatalError, and vpException::ioError.

Referenced by vpMbtKltXmlParser::read_klt(), vpMbtXmlParser::read_mask(), and vpMbtXmlParser::read_range().

Here is the caller graph for this function:

void vpXmlParser::xmlWriteCharChild ( xmlNodePtr  node, const char *  label, const char *  value  )

protectedinherited

write an array of character.

Parameters

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 254 of file vpXmlParser.cpp.

void vpXmlParser::xmlWriteDoubleChild ( xmlNodePtr  node, const char *  label, const double  value  )

protectedinherited

write a double.

Parameters

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 320 of file vpXmlParser.cpp.

void vpXmlParser::xmlWriteIntChild ( xmlNodePtr  node, const char *  label, const int  value  )

protectedinherited

write an integer.

Parameters

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 285 of file vpXmlParser.cpp.

void vpXmlParser::xmlWriteStringChild ( xmlNodePtr  node, const char *  label, const std::string &  value  )

protectedinherited

write an array of character.

Parameters

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 269 of file vpXmlParser.cpp.

void vpXmlParser::xmlWriteUnsignedIntChild ( xmlNodePtr  node, const char *  label, const unsigned int  value  )

protectedinherited

write an unsigned integer.

Parameters

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 302 of file vpXmlParser.cpp.

Member Data Documentation

double vpMbXmlParser::angleAppear

protected

Angle to determine if a face appeared.

Definition at line 73 of file vpMbXmlParser.h.

Referenced by read_face(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and readMainClass().

double vpMbXmlParser::angleDisappear

protected

Angle to determine if a face disappeared.

Definition at line 75 of file vpMbXmlParser.h.

Referenced by read_face(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and readMainClass().

vpCameraParameters vpMbXmlParser::cam

protected

Camera parameters.

Definition at line 71 of file vpMbXmlParser.h.

Referenced by read_camera(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and readMainClass().

double vpMbXmlParser::farClipping

protected

Near clipping distance.

Definition at line 83 of file vpMbXmlParser.h.

Referenced by read_face().

bool vpMbXmlParser::fovClipping

protected

Fov Clipping.

Definition at line 85 of file vpMbXmlParser.h.

Referenced by read_face().

bool vpMbXmlParser::hasFarClipping

protected

Is far clipping distance specified?

Definition at line 81 of file vpMbXmlParser.h.

Referenced by read_face().

bool vpMbXmlParser::hasNearClipping

protected

Is near clipping distance specified?

Definition at line 77 of file vpMbXmlParser.h.

Referenced by read_face().

std::string vpXmlParser::main_tag

protectedinherited

The name of the main tag for the file to parse

Definition at line 202 of file vpXmlParser.h.

Referenced by vpXmlParser::save(), and vpXmlParser::vpXmlParser().

double vpMbXmlParser::nearClipping

protected

Near clipping distance.

Definition at line 79 of file vpMbXmlParser.h.

Referenced by read_face().

std::map<std::string, int> vpXmlParser::nodeMap

protectedinherited

The map describing the data to parse

Definition at line 197 of file vpXmlParser.h.

Referenced by vpMbtEdgeKltXmlParser::init(), vpMbtXmlParser::init(), init(), vpMbtKltXmlParser::init(), read_camera(), vpMbtXmlParser::read_contrast(), vpMbtXmlParser::read_ecm(), read_face(), vpMbtKltXmlParser::read_klt(), vpMbtXmlParser::read_mask(), vpMbtXmlParser::read_range(), vpMbtXmlParser::read_sample(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), readMainClass(), and vpXmlParser::vpXmlParser().