Visual Servoing Platform  version 3.1.0
Protected Types | Protected Attributes | List of all members
vpMbtKltXmlParser Class Reference
tracker: ViSP trackers » mbt: Model-based tracker module » XML parsers

#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 63 of file vpMbtKltXmlParser.h.

Member Enumeration Documentation

◆ dataToParseMb

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 91 of file vpMbXmlParser.h.

◆ dataToParseMbKlt

enum vpMbtKltXmlParser::dataToParseMbKlt
protected
Enumerator
klt 
mask_border 
max_features 
window_size 
quality 
min_distance 
harris 
size_block 
pyramid_lvl 
last 

Definition at line 83 of file vpMbtKltXmlParser.h.

Constructor & Destructor Documentation

◆ vpMbtKltXmlParser()

vpMbtKltXmlParser::vpMbtKltXmlParser ( )

Default constructor.

Definition at line 53 of file vpMbtKltXmlParser.cpp.

References init().

◆ ~vpMbtKltXmlParser()

vpMbtKltXmlParser::~vpMbtKltXmlParser ( )
virtual

Default destructor.

Definition at line 63 of file vpMbtKltXmlParser.cpp.

Member Function Documentation

◆ cleanup()

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, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.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 310 of file vpXmlParser.h.

◆ getAngleAppear()

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

◆ getAngleDisappear()

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

◆ getBlockSize()

unsigned int vpMbtKltXmlParser::getBlockSize ( ) const
inline

Get the size of a block.

Returns
blockSize

Definition at line 107 of file vpMbtKltXmlParser.h.

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

◆ getCameraParameters()

void vpMbXmlParser::getCameraParameters ( vpCameraParameters &  _cam) const
inlineinherited

Definition at line 133 of file vpMbXmlParser.h.

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

◆ getFarClippingDistance()

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

◆ getFovClipping()

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

◆ getHarrisParam()

double vpMbtKltXmlParser::getHarrisParam ( ) const
inline

Get the Harris free parameter.

Returns
harrisParam

Definition at line 114 of file vpMbtKltXmlParser.h.

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

◆ getLodState()

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

◆ getMaskBorder()

unsigned int vpMbtKltXmlParser::getMaskBorder ( ) const
inline

Get the Border of the mask.

Returns
faceBorder

Definition at line 121 of file vpMbtKltXmlParser.h.

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

◆ getMaxFeatures()

unsigned int vpMbtKltXmlParser::getMaxFeatures ( ) const
inline

Get the maximum number of features for the KLT.

Returns
maxFeatures

Definition at line 128 of file vpMbtKltXmlParser.h.

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

◆ getMinDistance()

double vpMbtKltXmlParser::getMinDistance ( ) const
inline

Get the minimum distance between KLT points.

Returns
minDist

Definition at line 135 of file vpMbtKltXmlParser.h.

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

◆ getMinLineLengthThreshold()

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 161 of file vpMbXmlParser.h.

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

◆ getMinPolygonAreaThreshold()

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 168 of file vpMbXmlParser.h.

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

◆ getNearClippingDistance()

double vpMbXmlParser::getNearClippingDistance ( ) const
inlineinherited

Get the near clipping distance.

Returns
nearClipping

Definition at line 175 of file vpMbXmlParser.h.

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

◆ getPyramidLevels()

unsigned int vpMbtKltXmlParser::getPyramidLevels ( ) const
inline

Get the number of pyramid levels

Returns
pyramidLevels

Definition at line 142 of file vpMbtKltXmlParser.h.

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

◆ getQuality()

double vpMbtKltXmlParser::getQuality ( ) const
inline

Get the quality of the KLT.

Returns
quality

Definition at line 149 of file vpMbtKltXmlParser.h.

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

◆ getWindowSize()

unsigned int vpMbtKltXmlParser::getWindowSize ( ) const
inline

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

Returns
winSize

Definition at line 156 of file vpMbtKltXmlParser.h.

References vpMbXmlParser::parse(), and vpMbXmlParser::readMainClass().

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

◆ hasFarClippingDistance()

bool vpMbXmlParser::hasFarClippingDistance ( ) const
inlineinherited

Has Far clipping been specified?

Returns
True if yes, False otherwise.

Definition at line 182 of file vpMbXmlParser.h.

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

◆ hasNearClippingDistance()

bool vpMbXmlParser::hasNearClippingDistance ( ) const
inlineinherited

Has Near clipping been specified?

Returns
True if yes, False otherwise.

Definition at line 189 of file vpMbXmlParser.h.

References vpXmlParser::parse(), and vpXmlParser::readMainClass().

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

◆ init()

void vpMbtKltXmlParser::init ( void  )
protected

Initialise internal variables (including the map).

Definition at line 68 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().

◆ parse() [1/2]

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 89 of file vpMbtKltXmlParser.cpp.

References vpXmlParser::parse().

Referenced by vpMbKltTracker::loadConfigFile().

◆ parse() [2/2]

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

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

Referenced by vpXmlParserHomogeneousMatrix::getHomogeneousMatrixName(), vpXmlConfigParserKeyPoint::getUseRansacVVSPoseEstimation(), vpXmlParserCamera::getWidth(), vpMbXmlParser::hasNearClippingDistance(), vpMbtXmlGenericParser::hasNearClippingDistance(), vpMbtEdgeKltXmlParser::parse(), vpMbtXmlParser::parse(), parse(), vpMbXmlParser::parse(), vpXmlConfigParserKeyPoint::parse(), and vpMbtXmlGenericParser::parse().

◆ read_camera()

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

Read camera information.

Exceptions
vpException::fatalErrorif 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 181 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().

◆ read_face()

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

Read face information.

Exceptions
vpException::fatalErrorif 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 255 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().

◆ read_klt()

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

Read klt information.

Exceptions
vpException::fatalErrorif 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 187 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().

◆ read_lod()

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

Definition at line 326 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().

◆ 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 112 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.

◆ save()

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

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

Referenced by vpXmlParserHomogeneousMatrix::getHomogeneousMatrixName(), and vpXmlParserCamera::getWidth().

◆ setAngleAppear()

void vpMbXmlParser::setAngleAppear ( const double &  aappear)
inlineinherited

Set the angle to determine if a face appeared.

Parameters
aappear: New angleAppear

Definition at line 203 of file vpMbXmlParser.h.

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

◆ setAngleDisappear()

void vpMbXmlParser::setAngleDisappear ( const double &  adisappear)
inlineinherited

Set the angle to determine if a face disappeared.

Parameters
adisappear: New angleDisappear

Definition at line 210 of file vpMbXmlParser.h.

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

◆ setBlockSize()

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

Set the size of a block.

Parameters
bs: New blockSize

Definition at line 168 of file vpMbtKltXmlParser.h.

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

◆ setCameraParameters()

void vpMbXmlParser::setCameraParameters ( const vpCameraParameters &  _cam)
inlineinherited

Definition at line 212 of file vpMbXmlParser.h.

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

◆ setFarClippingDistance()

void vpMbXmlParser::setFarClippingDistance ( const double &  fclip)
inlineinherited

Set the far clipping distance.

Parameters
fclip: New farClipping

Definition at line 219 of file vpMbXmlParser.h.

◆ setHarrisParam()

void vpMbtKltXmlParser::setHarrisParam ( const double &  hp)
inline

Set the Harris free parameter.

Parameters
hp: New harrisParam

Definition at line 175 of file vpMbtKltXmlParser.h.

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

◆ setMainTag()

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

Referenced by vpMbXmlParser::init(), vpMbtXmlGenericParser::init(), and vpXmlConfigParserKeyPoint::vpXmlConfigParserKeyPoint().

◆ setMap()

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

◆ setMaskBorder()

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

Set the Border of the mask.

Parameters
mb= new maskBorder

Definition at line 182 of file vpMbtKltXmlParser.h.

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

◆ setMaxFeatures()

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

Set the maximum number of features for the KLT.

Parameters
mF: New maxFeatures

Definition at line 189 of file vpMbtKltXmlParser.h.

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

◆ setMinDistance()

void vpMbtKltXmlParser::setMinDistance ( const double &  mD)
inline

Set the minimum distance between KLT points.

Parameters
mD: New minDist

Definition at line 196 of file vpMbtKltXmlParser.h.

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

◆ setNearClippingDistance()

void vpMbXmlParser::setNearClippingDistance ( const double &  nclip)
inlineinherited

Set the near clipping distance.

Parameters
nclip: New nearClipping

Definition at line 226 of file vpMbXmlParser.h.

References vpXmlParser::writeMainClass().

◆ setPyramidLevels()

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

Set the number of pyramid levels

Parameters
pL: New pyramidLevels

Definition at line 203 of file vpMbtKltXmlParser.h.

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

◆ setQuality()

void vpMbtKltXmlParser::setQuality ( const double &  q)
inline

Set the quality of the KLT.

Parameters
q: New quality

Definition at line 210 of file vpMbtKltXmlParser.h.

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

◆ setWindowSize()

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 217 of file vpMbtKltXmlParser.h.

References vpMbXmlParser::init(), and vpMbXmlParser::writeMainClass().

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

◆ writeMainClass()

void vpMbtKltXmlParser::writeMainClass ( xmlNodePtr  node)
virtual

Write info to file.

Warning
Useless, so not yet implemented => Throw exception.

Implements vpXmlParser.

Definition at line 100 of file vpMbtKltXmlParser.cpp.

References vpException::notImplementedError.

◆ xmlReadBoolChild()

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

References vpException::fatalError.

◆ xmlReadCharChild()

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

References vpException::fatalError.

Referenced by vpXmlParserHomogeneousMatrix::save(), and vpXmlParserCamera::save().

◆ xmlReadDoubleChild()

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
Examples:
testXmlParser.cpp.

Definition at line 212 of file vpXmlParser.cpp.

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

Referenced by vpXmlConfigParserKeyPoint::parse(), vpMbXmlParser::read_camera(), vpMbtXmlGenericParser::read_camera(), vpMbtXmlParser::read_contrast(), vpMbtXmlGenericParser::read_depth_normal_PCL(), vpMbtXmlGenericParser::read_ecm_contrast(), vpMbXmlParser::read_face(), vpMbtXmlGenericParser::read_face(), read_klt(), vpMbtXmlGenericParser::read_klt(), vpMbXmlParser::read_lod(), vpMbtXmlGenericParser::read_lod(), vpXmlParserHomogeneousMatrix::save(), and vpXmlParserCamera::save().

◆ xmlReadFloatChild()

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

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

◆ xmlReadIntChild()

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
Examples:
testXmlParser.cpp.

Definition at line 144 of file vpXmlParser.cpp.

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

Referenced by vpXmlConfigParserKeyPoint::parse(), vpMbtXmlGenericParser::read_depth_normal(), vpMbtXmlGenericParser::read_depth_normal_PCL(), vpMbtXmlGenericParser::read_ecm_sample(), vpMbXmlParser::read_face(), vpMbtXmlGenericParser::read_face(), vpMbXmlParser::read_lod(), vpMbtXmlGenericParser::read_lod(), vpMbtXmlParser::read_sample(), vpMbtXmlParser::read_sample_deprecated(), and vpMbtXmlGenericParser::read_sample_deprecated().

◆ xmlReadStringChild()

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.
Examples:
testXmlParser.cpp.

Definition at line 120 of file vpXmlParser.cpp.

References vpException::fatalError.

Referenced by vpXmlConfigParserKeyPoint::parse().

◆ xmlReadUnsignedIntChild()

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

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

Referenced by vpMbtXmlGenericParser::read_depth_dense_sampling_step(), vpMbtXmlGenericParser::read_depth_normal_sampling_step(), vpMbtXmlGenericParser::read_ecm_mask(), vpMbtXmlGenericParser::read_ecm_range(), read_klt(), vpMbtXmlGenericParser::read_klt(), vpMbtXmlParser::read_mask(), vpMbtXmlParser::read_range(), and vpXmlParserCamera::save().

◆ xmlWriteBoolChild()

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

◆ xmlWriteCharChild()

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
Examples:
testXmlParser.cpp.

Definition at line 306 of file vpXmlParser.cpp.

◆ xmlWriteDoubleChild()

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
Examples:
testXmlParser.cpp.

Definition at line 366 of file vpXmlParser.cpp.

◆ xmlWriteFloatChild()

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

◆ xmlWriteIntChild()

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
Examples:
testXmlParser.cpp.

Definition at line 334 of file vpXmlParser.cpp.

◆ xmlWriteStringChild()

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

◆ xmlWriteUnsignedIntChild()

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

Member Data Documentation

◆ angleAppear

double vpMbXmlParser::angleAppear
protectedinherited

Angle to determine if a face appeared.

Definition at line 71 of file vpMbXmlParser.h.

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

◆ angleDisappear

double vpMbXmlParser::angleDisappear
protectedinherited

Angle to determine if a face disappeared.

Definition at line 73 of file vpMbXmlParser.h.

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

◆ blockSize

unsigned int vpMbtKltXmlParser::blockSize
protected

Block size.

Definition at line 79 of file vpMbtKltXmlParser.h.

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

◆ cam

vpCameraParameters vpMbXmlParser::cam
protectedinherited

Camera parameters.

Definition at line 69 of file vpMbXmlParser.h.

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

◆ farClipping

double vpMbXmlParser::farClipping
protectedinherited

Near clipping distance.

Definition at line 81 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

◆ fovClipping

bool vpMbXmlParser::fovClipping
protectedinherited

Fov Clipping.

Definition at line 83 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

◆ harrisParam

double vpMbtKltXmlParser::harrisParam
protected

Harris free parameters.

Definition at line 77 of file vpMbtKltXmlParser.h.

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

◆ hasFarClipping

bool vpMbXmlParser::hasFarClipping
protectedinherited

Is far clipping distance specified?

Definition at line 79 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

◆ hasNearClipping

bool vpMbXmlParser::hasNearClipping
protectedinherited

Is near clipping distance specified?

Definition at line 75 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

◆ main_tag

std::string vpXmlParser::main_tag
protectedinherited

The name of the main tag for the file to parse

Definition at line 231 of file vpXmlParser.h.

Referenced by vpXmlParser::save().

◆ maskBorder

unsigned int vpMbtKltXmlParser::maskBorder
protected

Border of the mask used on Klt points.

Definition at line 67 of file vpMbtKltXmlParser.h.

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

◆ maxFeatures

unsigned int vpMbtKltXmlParser::maxFeatures
protected

Maximum of Klt features.

Definition at line 69 of file vpMbtKltXmlParser.h.

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

◆ minDist

double vpMbtKltXmlParser::minDist
protected

Minimum distance between klt points.

Definition at line 75 of file vpMbtKltXmlParser.h.

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

◆ minLineLengthThreshold

double vpMbXmlParser::minLineLengthThreshold
protectedinherited

Minimum line length to track a segment 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().

◆ minPolygonAreaThreshold

double vpMbXmlParser::minPolygonAreaThreshold
protectedinherited

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

Definition at line 89 of file vpMbXmlParser.h.

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

◆ nearClipping

double vpMbXmlParser::nearClipping
protectedinherited

Near clipping distance.

Definition at line 77 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_face().

◆ nodeMap

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

The map describing the data to parse

Definition at line 226 of file vpXmlParser.h.

Referenced by vpMbtEdgeKltXmlParser::init(), vpMbtXmlParser::init(), init(), vpMbXmlParser::init(), vpMbtXmlGenericParser::init(), vpXmlConfigParserKeyPoint::parse(), vpMbXmlParser::read_camera(), vpMbtXmlGenericParser::read_camera(), vpMbtXmlParser::read_contrast(), vpMbtXmlGenericParser::read_depth_dense(), vpMbtXmlGenericParser::read_depth_dense_sampling_step(), vpMbtXmlGenericParser::read_depth_normal(), vpMbtXmlGenericParser::read_depth_normal_PCL(), vpMbtXmlGenericParser::read_depth_normal_sampling_step(), vpMbtXmlParser::read_ecm(), vpMbtXmlGenericParser::read_ecm(), vpMbtXmlGenericParser::read_ecm_contrast(), vpMbtXmlGenericParser::read_ecm_mask(), vpMbtXmlGenericParser::read_ecm_range(), vpMbtXmlGenericParser::read_ecm_sample(), vpMbXmlParser::read_face(), vpMbtXmlGenericParser::read_face(), read_klt(), vpMbtXmlGenericParser::read_klt(), vpMbXmlParser::read_lod(), vpMbtXmlGenericParser::read_lod(), vpMbtXmlParser::read_mask(), vpMbtXmlParser::read_range(), vpMbtXmlParser::read_sample(), vpMbtXmlParser::read_sample_deprecated(), vpMbtXmlGenericParser::read_sample_deprecated(), vpMbtEdgeKltXmlParser::readMainClass(), vpMbtXmlParser::readMainClass(), readMainClass(), vpMbXmlParser::readMainClass(), vpMbtXmlGenericParser::readMainClass(), and vpXmlConfigParserKeyPoint::vpXmlConfigParserKeyPoint().

◆ pyramidLevels

unsigned int vpMbtKltXmlParser::pyramidLevels
protected

Number of pyramid levels.

Definition at line 81 of file vpMbtKltXmlParser.h.

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

◆ qualityValue

double vpMbtKltXmlParser::qualityValue
protected

Quality of the Klt points.

Definition at line 73 of file vpMbtKltXmlParser.h.

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

◆ useLod

bool vpMbXmlParser::useLod
protectedinherited

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

Definition at line 85 of file vpMbXmlParser.h.

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

◆ winSize

unsigned int vpMbtKltXmlParser::winSize
protected

Windows size.

Definition at line 71 of file vpMbtKltXmlParser.h.

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