vpMbtKltXmlParser Class Reference

#include <visp3/mbt/vpMbtKltXmlParser.h>

Inheritance diagram for vpMbtKltXmlParser:

Public Member Functions
Public Member Functions Inherited from vpMbtKltXmlParser
	vpMbtKltXmlParser ()
virtual	~vpMbtKltXmlParser ()
unsigned int	getBlockSize () const
double	getHarrisParam () const
unsigned int	getMaskBorder () const
unsigned int	getMaxFeatures () const
double	getMinDistance () const
unsigned int	getPyramidLevels () const
double	getQuality () const
unsigned int	getWindowSize () const
void	parse (const char *filename)
virtual void	readMainClass (xmlDocPtr doc, xmlNodePtr node)
void	read_klt (xmlDocPtr doc, xmlNodePtr node)
void	setBlockSize (const unsigned int &bs)
void	setHarrisParam (const double &hp)
void	setMaskBorder (const unsigned int &mb)
void	setMaxFeatures (const unsigned int &mF)
void	setMinDistance (const double &mD)
void	setPyramidLevels (const unsigned int &pL)
void	setQuality (const double &q)
void	setWindowSize (const unsigned int &w)
void	writeMainClass (xmlNodePtr node)
Public Member Functions Inherited from vpMbXmlParser
double	getAngleAppear () const
double	getAngleDisappear () const
void	getCameraParameters (vpCameraParameters &_cam) const
double	getFarClippingDistance () const
bool	getFovClipping () const
bool	getLodState () const
double	getMinLineLengthThreshold () const
double	getMinPolygonAreaThreshold () const
double	getNearClippingDistance () const
bool	hasFarClippingDistance () const
bool	hasNearClippingDistance () const
void	read_camera (xmlDocPtr doc, xmlNodePtr node)
void	read_face (xmlDocPtr doc, xmlNodePtr node)
void	read_lod (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)
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 Types
enum	dataToParseMbKlt {   klt = vpMbXmlParser::last, mask_border, max_features, window_size,   quality, min_distance, harris, size_block,   pyramid_lvl, last }
enum	dataToParseMb {   conf, face, angle_appear, angle_disappear,   near_clipping, far_clipping, fov_clipping, camera,   height, width, u0, v0,   px, py, lod, use_lod,   min_line_length_threshold, min_polygon_area_threshold, last }

Protected Member Functions
Protected Member Functions Inherited from vpMbtKltXmlParser
void	init ()
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
unsigned int	maskBorder
unsigned int	maxFeatures
unsigned int	winSize
double	qualityValue
double	minDist
double	harrisParam
unsigned int	blockSize
unsigned int	pyramidLevels
vpCameraParameters	cam
double	angleAppear
double	angleDisappear
bool	hasNearClipping
double	nearClipping
bool	hasFarClipping
double	farClipping
bool	fovClipping
bool	useLod
double	minLineLengthThreshold
double	minPolygonAreaThreshold
std::map< std::string, int >	nodeMap
std::string	main_tag

Detailed Description

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

Data parser for the KLT model based tracker.

Definition at line 61 of file vpMbtKltXmlParser.h.

Member Enumeration Documentation

enum vpMbXmlParser::dataToParseMb

protectedinherited

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

Definition at line 89 of file vpMbXmlParser.h.

enum vpMbtKltXmlParser::dataToParseMbKlt

protected

Enumerator
klt
mask_border
max_features
window_size
quality
min_distance
harris
size_block
pyramid_lvl
last

Definition at line 81 of file vpMbtKltXmlParser.h.

Constructor & Destructor Documentation

vpMbtKltXmlParser::vpMbtKltXmlParser

(

)

Default constructor.

Definition at line 53 of file vpMbtKltXmlParser.cpp.

References init().

vpMbtKltXmlParser::~vpMbtKltXmlParser ( )

virtual

Default destructor.

Definition at line 63 of file vpMbtKltXmlParser.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:

mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtKltMultiTracking.cpp, mbtKltTracking.cpp, testXmlParser.cpp, tutorial-detection-object-mbt.cpp, tutorial-detection-object-mbt2.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, and tutorial-mb-tracker-full.cpp.

Definition at line 308 of file vpXmlParser.h.

double vpMbXmlParser::getAngleAppear ( ) const

inlineinherited

Get the angle to determine if a face appeared.

Returns

angleAppear

Definition at line 124 of file vpMbXmlParser.h.

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

double vpMbXmlParser::getAngleDisappear ( ) const

inlineinherited

Get the angle to determine if a face disappeared.

Returns

angleDisappear

Definition at line 131 of file vpMbXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getBlockSize ( ) const

inline

Get the size of a block.

Returns

blockSize

Definition at line 106 of file vpMbtKltXmlParser.h.

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

void vpMbXmlParser::getCameraParameters ( vpCameraParameters &  _cam ) const

inlineinherited

Definition at line 133 of file vpMbXmlParser.h.

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

double vpMbXmlParser::getFarClippingDistance ( ) const

inlineinherited

Get the far clipping distance.

Returns

farClipping

Definition at line 140 of file vpMbXmlParser.h.

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

bool vpMbXmlParser::getFovClipping ( ) const

inlineinherited

Use FOV clipping

Returns

True if yes, False otherwise.

Definition at line 147 of file vpMbXmlParser.h.

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

double vpMbtKltXmlParser::getHarrisParam ( ) const

inline

Get the Harris free parameter.

Returns

harrisParam

Definition at line 113 of file vpMbtKltXmlParser.h.

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

bool vpMbXmlParser::getLodState ( ) const

inlineinherited

Get the state of LOD setting.

Returns

True if LOD is enabled, false otherwise.

Definition at line 154 of file vpMbXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getMaskBorder ( ) const

inline

Get the Border of the mask.

Returns

faceBorder

Definition at line 120 of file vpMbtKltXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getMaxFeatures ( ) const

inline

Get the maximum number of features for the KLT.

Returns

maxFeatures

Definition at line 127 of file vpMbtKltXmlParser.h.

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

double vpMbtKltXmlParser::getMinDistance ( ) const

inline

Get the minimum distance between KLT points.

Returns

minDist

Definition at line 134 of file vpMbtKltXmlParser.h.

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

double vpMbXmlParser::getMinLineLengthThreshold ( ) const

inlineinherited

Get the minimum line length to track a segment when LOD is enabled.

Returns

The minimum line length.

Definition at line 163 of file vpMbXmlParser.h.

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

double vpMbXmlParser::getMinPolygonAreaThreshold ( ) const

inlineinherited

Get the minimum polygon area to track a face when LOD is enabled.

Returns

The minimum polygon area.

Definition at line 172 of file vpMbXmlParser.h.

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

double vpMbXmlParser::getNearClippingDistance ( ) const

inlineinherited

Get the near clipping distance.

Returns

nearClipping

Definition at line 181 of file vpMbXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getPyramidLevels ( ) const

inline

Get the number of pyramid levels

Returns

pyramidLevels

Definition at line 141 of file vpMbtKltXmlParser.h.

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

double vpMbtKltXmlParser::getQuality ( ) const

inline

Get the quality of the KLT.

Returns

quality

Definition at line 148 of file vpMbtKltXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getWindowSize ( ) const

inline

Get the size of the window used in the KLT tracker.

Returns

winSize

Definition at line 155 of file vpMbtKltXmlParser.h.

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

bool vpMbXmlParser::hasFarClippingDistance ( ) const

inlineinherited

Has Far clipping been specified?

Returns

True if yes, False otherwise.

Definition at line 188 of file vpMbXmlParser.h.

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

bool vpMbXmlParser::hasNearClippingDistance ( ) const

inlineinherited

Has Near clipping been specified?

Returns

True if yes, False otherwise.

Definition at line 195 of file vpMbXmlParser.h.

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

void vpMbtKltXmlParser::init ( void  )

protected

Initialise internal variables (including the map).

Definition at line 71 of file vpMbtKltXmlParser.cpp.

References harris, vpMbXmlParser::init(), klt, mask_border, max_features, min_distance, vpXmlParser::nodeMap, pyramid_lvl, quality, size_block, and window_size.

Referenced by vpMbtEdgeKltXmlParser::init(), and vpMbtKltXmlParser().

void vpMbtKltXmlParser::parse

(

const char *

filename

)

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

Parameters

filename

: File to parse.

Definition at line 93 of file vpMbtKltXmlParser.cpp.

References vpXmlParser::parse().

Referenced by vpMbKltTracker::loadConfigFile().

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

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

Referenced by vpMbtEdgeKltXmlParser::parse(), vpMbtXmlParser::parse(), parse(), vpMbXmlParser::parse(), and vpXmlConfigParserKeyPoint::parse().

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

inherited

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 190 of file vpMbXmlParser.cpp.

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

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

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

inherited

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 264 of file vpMbXmlParser.cpp.

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

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

void vpMbtKltXmlParser::read_klt	(	xmlDocPtr	doc,
		xmlNodePtr	node
	)

Read klt 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 193 of file vpMbtKltXmlParser.cpp.

References blockSize, harris, harrisParam, mask_border, maskBorder, max_features, maxFeatures, min_distance, minDist, vpXmlParser::nodeMap, pyramid_lvl, pyramidLevels, quality, qualityValue, size_block, window_size, winSize, vpXmlParser::xmlReadDoubleChild(), and vpXmlParser::xmlReadUnsignedIntChild().

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

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

inherited

Definition at line 335 of file vpMbXmlParser.cpp.

References vpMbXmlParser::min_line_length_threshold, vpMbXmlParser::min_polygon_area_threshold, vpMbXmlParser::minLineLengthThreshold, vpMbXmlParser::minPolygonAreaThreshold, vpXmlParser::nodeMap, vpMbXmlParser::use_lod, vpMbXmlParser::useLod, vpXmlParser::xmlReadDoubleChild(), and vpXmlParser::xmlReadIntChild().

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

void vpMbtKltXmlParser::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.

Reimplemented from vpMbXmlParser.

Reimplemented in vpMbtEdgeKltXmlParser.

Definition at line 118 of file vpMbtKltXmlParser.cpp.

References vpMbXmlParser::angleAppear, vpMbXmlParser::angleDisappear, blockSize, vpMbXmlParser::cam, vpMbXmlParser::camera, vpMbXmlParser::face, vpCameraParameters::get_px(), vpCameraParameters::get_py(), vpCameraParameters::get_u0(), vpCameraParameters::get_v0(), harrisParam, klt, vpMbXmlParser::lod, maskBorder, maxFeatures, minDist, vpMbXmlParser::minLineLengthThreshold, vpMbXmlParser::minPolygonAreaThreshold, vpXmlParser::nodeMap, pyramidLevels, qualityValue, vpMbXmlParser::read_camera(), vpMbXmlParser::read_face(), read_klt(), vpMbXmlParser::read_lod(), vpMbXmlParser::useLod, and winSize.

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

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

void vpMbXmlParser::setAngleAppear ( const double &  aappear )

inlineinherited

Set the angle to determine if a face appeared.

Parameters

aappear

: New angleAppear

Definition at line 209 of file vpMbXmlParser.h.

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

void vpMbXmlParser::setAngleDisappear ( const double &  adisappear )

inlineinherited

Set the angle to determine if a face disappeared.

Parameters

adisappear

: New angleDisappear

Definition at line 216 of file vpMbXmlParser.h.

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

void vpMbtKltXmlParser::setBlockSize ( const unsigned int &  bs )

inline

Set the size of a block.

Parameters

bs	: New blockSize

Definition at line 167 of file vpMbtKltXmlParser.h.

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

void vpMbXmlParser::setCameraParameters ( const vpCameraParameters &  _cam )

inlineinherited

Definition at line 218 of file vpMbXmlParser.h.

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

void vpMbXmlParser::setFarClippingDistance ( const double &  fclip )

inlineinherited

Set the far clipping distance.

Parameters

fclip

: New farClipping

Definition at line 225 of file vpMbXmlParser.h.

void vpMbtKltXmlParser::setHarrisParam ( const double &  hp )

inline

Set the Harris free parameter.

Parameters

hp	: New harrisParam

Definition at line 174 of file vpMbtKltXmlParser.h.

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

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 293 of file vpXmlParser.h.

Referenced by vpMbXmlParser::init().

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 284 of file vpXmlParser.h.

void vpMbtKltXmlParser::setMaskBorder ( const unsigned int &  mb )

inline

Set the Border of the mask.

Parameters

mb	= new maskBorder

Definition at line 181 of file vpMbtKltXmlParser.h.

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

void vpMbtKltXmlParser::setMaxFeatures ( const unsigned int &  mF )

inline

Set the maximum number of features for the KLT.

Parameters

mF	: New maxFeatures

Definition at line 188 of file vpMbtKltXmlParser.h.

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

void vpMbtKltXmlParser::setMinDistance ( const double &  mD )

inline

Set the minimum distance between KLT points.

Parameters

mD	: New minDist

Definition at line 195 of file vpMbtKltXmlParser.h.

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

void vpMbXmlParser::setNearClippingDistance ( const double &  nclip )

inlineinherited

Set the near clipping distance.

Parameters

nclip

: New nearClipping

Definition at line 232 of file vpMbXmlParser.h.

void vpMbtKltXmlParser::setPyramidLevels ( const unsigned int &  pL )

inline

Set the number of pyramid levels

Parameters

pL	: New pyramidLevels

Definition at line 202 of file vpMbtKltXmlParser.h.

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

void vpMbtKltXmlParser::setQuality ( const double &  q )

inline

Set the quality of the KLT.

Parameters

q	: New quality

Definition at line 209 of file vpMbtKltXmlParser.h.

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

void vpMbtKltXmlParser::setWindowSize ( const unsigned int &  w )

inline

Set the size of the window used in the KLT tracker.

Parameters

w	: New winSize

Definition at line 216 of file vpMbtKltXmlParser.h.

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

void vpMbtKltXmlParser::writeMainClass ( xmlNodePtr  node )

virtual

Write info to file.

Warning

Useless, so not yet implemented => Throw exception.

Implements vpXmlParser.

Definition at line 105 of file vpMbtKltXmlParser.cpp.

References vpException::notImplementedError.

bool vpXmlParser::xmlReadBoolChild ( xmlDocPtr  doc, xmlNodePtr  node  )

protectedinherited

read a boolean

Warning

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

Parameters

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

Returns

the bool value in the node

Definition at line 289 of file vpXmlParser.cpp.

References vpException::fatalError.

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 106 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 a double

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

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

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

float vpXmlParser::xmlReadFloatChild ( xmlDocPtr  doc, xmlNodePtr  node  )

protectedinherited

read a float

Warning

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

Parameters

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

Returns

the float value in the node

Definition at line 252 of file vpXmlParser.cpp.

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

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

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 127 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 unsigned 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 185 of file vpXmlParser.cpp.

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

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

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

protectedinherited

write a bool.

Parameters

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.

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

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

protectedinherited

write a float.

Parameters

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.

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 345 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 329 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 362 of file vpXmlParser.cpp.

Member Data Documentation

double vpMbXmlParser::angleAppear

protectedinherited

Angle to determine if a face appeared.

Definition at line 69 of file vpMbXmlParser.h.

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

double vpMbXmlParser::angleDisappear

protectedinherited

Angle to determine if a face disappeared.

Definition at line 71 of file vpMbXmlParser.h.

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

unsigned int vpMbtKltXmlParser::blockSize

protected

Block size.

Definition at line 77 of file vpMbtKltXmlParser.h.

Referenced by read_klt(), vpMbtEdgeKltXmlParser::readMainClass(), and readMainClass().

vpCameraParameters vpMbXmlParser::cam

protectedinherited

Camera parameters.

Definition at line 67 of file vpMbXmlParser.h.

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

double vpMbXmlParser::farClipping

protectedinherited

Near clipping distance.

Definition at line 79 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

bool vpMbXmlParser::fovClipping

protectedinherited

Fov Clipping.

Definition at line 81 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

double vpMbtKltXmlParser::harrisParam

protected

Harris free parameters.

Definition at line 75 of file vpMbtKltXmlParser.h.

Referenced by read_klt(), vpMbtEdgeKltXmlParser::readMainClass(), and readMainClass().

bool vpMbXmlParser::hasFarClipping

protectedinherited

Is far clipping distance specified?

Definition at line 77 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

bool vpMbXmlParser::hasNearClipping

protectedinherited

Is near clipping distance specified?

Definition at line 73 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

std::string vpXmlParser::main_tag

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

unsigned int vpMbtKltXmlParser::maskBorder

protected

Border of the mask used on Klt points.

Definition at line 65 of file vpMbtKltXmlParser.h.

Referenced by read_klt(), vpMbtEdgeKltXmlParser::readMainClass(), and readMainClass().

unsigned int vpMbtKltXmlParser::maxFeatures

protected

Maximum of Klt features.

Definition at line 67 of file vpMbtKltXmlParser.h.

Referenced by read_klt(), vpMbtEdgeKltXmlParser::readMainClass(), and readMainClass().

double vpMbtKltXmlParser::minDist

protected

Minimum distance between klt points.

Definition at line 73 of file vpMbtKltXmlParser.h.

Referenced by read_klt(), vpMbtEdgeKltXmlParser::readMainClass(), and readMainClass().

double vpMbXmlParser::minLineLengthThreshold

protectedinherited

Minimum line length to track a segment when LOD is enabled.

Definition at line 85 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_lod(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), readMainClass(), and vpMbXmlParser::readMainClass().

double vpMbXmlParser::minPolygonAreaThreshold

protectedinherited

Minimum polygon area to track a face when LOD is enabled.

Definition at line 87 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_lod(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), readMainClass(), and vpMbXmlParser::readMainClass().

double vpMbXmlParser::nearClipping

protectedinherited

Near clipping distance.

Definition at line 75 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

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

protectedinherited

The map describing the data to parse

Definition at line 224 of file vpXmlParser.h.

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

unsigned int vpMbtKltXmlParser::pyramidLevels

protected

Number of pyramid levels.

Definition at line 79 of file vpMbtKltXmlParser.h.

Referenced by read_klt(), vpMbtEdgeKltXmlParser::readMainClass(), and readMainClass().

double vpMbtKltXmlParser::qualityValue

protected

Quality of the Klt points.

Definition at line 71 of file vpMbtKltXmlParser.h.

Referenced by read_klt(), vpMbtEdgeKltXmlParser::readMainClass(), and readMainClass().

bool vpMbXmlParser::useLod

protectedinherited

If true, the LOD is enabled, otherwise it is not.

Definition at line 83 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_lod(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), readMainClass(), and vpMbXmlParser::readMainClass().

unsigned int vpMbtKltXmlParser::winSize

protected

Windows size.

Definition at line 69 of file vpMbtKltXmlParser.h.

Referenced by read_klt(), vpMbtEdgeKltXmlParser::readMainClass(), and readMainClass().