Visual Servoing Platform  version 3.0.0
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vpMbtEdgeKltXmlParser Class Reference
tracker: ViSP trackers » mbt: Model-based tracker module » XML parsers

#include <visp3/mbt/vpMbtEdgeKltXmlParser.h>

+ Inheritance diagram for vpMbtEdgeKltXmlParser:

Public Member Functions

 vpMbtEdgeKltXmlParser ()
 
virtual ~vpMbtEdgeKltXmlParser ()
 
void parse (const char *filename)
 
virtual void readMainClass (xmlDocPtr doc, xmlNodePtr node)
 
void writeMainClass (xmlNodePtr node)
 
void getMe (vpMe &_ecm) const
 
void parse (const std::string &filename)
 
void read_ecm (xmlDocPtr doc, xmlNodePtr node)
 
void read_sample (xmlDocPtr doc, xmlNodePtr node)
 
void read_sample_deprecated (xmlDocPtr doc, xmlNodePtr node)
 
void read_mask (xmlDocPtr doc, xmlNodePtr node)
 
void read_range (xmlDocPtr doc, xmlNodePtr node)
 
void read_contrast (xmlDocPtr doc, xmlNodePtr node)
 
void setMovingEdge (const vpMe &_ecm)
 
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)
 
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)
 
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 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)
 

Static Public Member Functions

static void cleanup ()
 

Protected Types

enum  dataToParseMbtEdgeKlt {
  camera, face, klt, ecm,
  lod
}
 
enum  dataToParseMb {
  ecm = vpMbXmlParser::last, mask, size, nb_mask,
  range, tracking, contrast, edge_threshold,
  mu1, mu2, sample, step,
  last
}
 
enum  dataToParseMbKlt {
  klt = vpMbXmlParser::last, mask_border, max_features, window_size,
  quality, min_distance, harris, size_block,
  pyramid_lvl, 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

vpMe m_ecm
 
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
 
unsigned int maskBorder
 
unsigned int maxFeatures
 
unsigned int winSize
 
double qualityValue
 
double minDist
 
double harrisParam
 
unsigned int blockSize
 
unsigned int pyramidLevels
 

Detailed Description

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

Data parser for the model based tracker.

Definition at line 63 of file vpMbtEdgeKltXmlParser.h.

Member Enumeration Documentation

enum vpMbtXmlParser::dataToParseMb
protectedinherited
Enumerator
ecm 
mask 
size 
nb_mask 
range 
tracking 
contrast 
edge_threshold 
mu1 
mu2 
sample 
step 
last 

Definition at line 69 of file vpMbtXmlParser.h.

enum vpMbtKltXmlParser::dataToParseMbKlt
protectedinherited
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.

enum vpMbtEdgeKltXmlParser::dataToParseMbtEdgeKlt
protected
Enumerator
camera 
face 
klt 
ecm 
lod 

Definition at line 66 of file vpMbtEdgeKltXmlParser.h.

Constructor & Destructor Documentation

vpMbtEdgeKltXmlParser::vpMbtEdgeKltXmlParser ( )

Default constructor.

Definition at line 54 of file vpMbtEdgeKltXmlParser.cpp.

References init().

vpMbtEdgeKltXmlParser::~vpMbtEdgeKltXmlParser ( )
virtual

Default destructor.

Definition at line 62 of file vpMbtEdgeKltXmlParser.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-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 216 of file vpXmlParser.h.

double vpMbXmlParser::getAngleAppear ( ) const
inlineinherited

Get the angle to determine if a face appeared.

Returns
angleAppear

Definition at line 122 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 129 of file vpMbXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getBlockSize ( ) const
inlineinherited

Get the size of a block.

Returns
blockSize

Definition at line 105 of file vpMbtKltXmlParser.h.

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

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

Definition at line 131 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 138 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 145 of file vpMbXmlParser.h.

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

double vpMbtKltXmlParser::getHarrisParam ( ) const
inlineinherited

Get the Harris free parameter.

Returns
harrisParam

Definition at line 112 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 152 of file vpMbXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getMaskBorder ( ) const
inlineinherited

Get the Border of the mask.

Returns
faceBorder

Definition at line 119 of file vpMbtKltXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getMaxFeatures ( ) const
inlineinherited

Get the maximum number of features for the KLT.

Returns
maxFeatures

Definition at line 126 of file vpMbtKltXmlParser.h.

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

void vpMbtXmlParser::getMe ( vpMe &  _ecm) const
inlineinherited

Definition at line 94 of file vpMbtXmlParser.h.

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

double vpMbtKltXmlParser::getMinDistance ( ) const
inlineinherited

Get the minimum distance between KLT points.

Returns
minDist

Definition at line 133 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 161 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 170 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 179 of file vpMbXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getPyramidLevels ( ) const
inlineinherited

Get the number of pyramid levels

Returns
pyramidLevels

Definition at line 140 of file vpMbtKltXmlParser.h.

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

double vpMbtKltXmlParser::getQuality ( ) const
inlineinherited

Get the quality of the KLT.

Returns
quality

Definition at line 147 of file vpMbtKltXmlParser.h.

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

unsigned int vpMbtKltXmlParser::getWindowSize ( ) const
inlineinherited

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

Returns
winSize

Definition at line 154 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 186 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 193 of file vpMbXmlParser.h.

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

void vpMbtEdgeKltXmlParser::init ( void  )
protected

Initialise internal variables (including the map).

Definition at line 70 of file vpMbtEdgeKltXmlParser.cpp.

References camera, ecm, face, vpMbtXmlParser::init(), vpMbtKltXmlParser::init(), klt, lod, and vpXmlParser::nodeMap.

Referenced by vpMbtEdgeKltXmlParser().

void vpMbtEdgeKltXmlParser::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 vpMbtEdgeKltXmlParser.cpp.

References vpXmlParser::parse().

Referenced by vpMbEdgeKltTracker::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 339 of file vpXmlParser.cpp.

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

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

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 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 readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and vpMbXmlParser::readMainClass().

void vpMbtXmlParser::read_contrast ( xmlDocPtr  doc,
xmlNodePtr  node 
)
inherited

Read the contrast information from the xml file.

Exceptions
vpException::fatalErrorif there was an unexpected number of data.
Parameters
doc: Pointer to the document.
node: Pointer to the node of the contrast information.

Definition at line 462 of file vpMbtXmlParser.cpp.

References vpMbtXmlParser::edge_threshold, vpMe::getMu1(), vpMe::getMu2(), vpMe::getThreshold(), vpMbtXmlParser::m_ecm, vpMbtXmlParser::mu1, vpMbtXmlParser::mu2, vpXmlParser::nodeMap, vpMe::setMu1(), vpMe::setMu2(), vpMe::setThreshold(), and vpXmlParser::xmlReadDoubleChild().

Referenced by vpMbtXmlParser::read_ecm().

void vpMbtXmlParser::read_ecm ( xmlDocPtr  doc,
xmlNodePtr  node 
)
inherited

Read ecm information.

Exceptions
vpException::fatalErrorif there was an unexpected number of data.
Parameters
doc: Pointer to the document.
node: Pointer to the node of the ecm information.

Definition at line 201 of file vpMbtXmlParser.cpp.

References vpMbtXmlParser::contrast, vpMe::getMaskNumber(), vpMe::getMaskSize(), vpMe::getMu1(), vpMe::getMu2(), vpMe::getRange(), vpMe::getSampleStep(), vpMe::getThreshold(), vpMbtXmlParser::m_ecm, vpMbtXmlParser::mask, vpXmlParser::nodeMap, vpMbtXmlParser::range, vpMbtXmlParser::read_contrast(), vpMbtXmlParser::read_mask(), vpMbtXmlParser::read_range(), vpMbtXmlParser::read_sample(), and vpMbtXmlParser::sample.

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

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 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 readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and vpMbXmlParser::readMainClass().

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

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

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

Referenced by readMainClass(), and vpMbtKltXmlParser::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 readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and vpMbXmlParser::readMainClass().

void vpMbtXmlParser::read_mask ( xmlDocPtr  doc,
xmlNodePtr  node 
)
inherited

Read mask information for the vpMeSite.

Exceptions
vpException::fatalErrorif there was an unexpected number of data.
Parameters
doc: Pointer to the document.
node: Pointer to the node of the mask information.

Definition at line 364 of file vpMbtXmlParser.cpp.

References vpException::badValue, vpMe::getMaskNumber(), vpMe::getMaskSize(), vpMbtXmlParser::m_ecm, vpMbtXmlParser::nb_mask, vpXmlParser::nodeMap, vpMe::setMaskNumber(), vpMe::setMaskSize(), vpMbtXmlParser::size, and vpXmlParser::xmlReadUnsignedIntChild().

Referenced by vpMbtXmlParser::read_ecm().

void vpMbtXmlParser::read_range ( xmlDocPtr  doc,
xmlNodePtr  node 
)
inherited

Read range information for the vpMeSite.

Exceptions
vpException::fatalErrorif there was an unexpected number of data.
Parameters
doc: Pointer to the document.
node: Pointer to the node of the range information.

Definition at line 420 of file vpMbtXmlParser.cpp.

References vpMe::getRange(), vpMbtXmlParser::m_ecm, vpXmlParser::nodeMap, vpMe::setRange(), vpMbtXmlParser::tracking, and vpXmlParser::xmlReadUnsignedIntChild().

Referenced by vpMbtXmlParser::read_ecm().

void vpMbtXmlParser::read_sample ( xmlDocPtr  doc,
xmlNodePtr  node 
)
inherited

Read sample information.

Exceptions
vpException::fatalErrorif there was an unexpected number of data.
Parameters
doc: Pointer to the document.
node: Pointer to the node of the sample information.

Definition at line 266 of file vpMbtXmlParser.cpp.

References vpMe::getSampleStep(), vpMbtXmlParser::m_ecm, vpXmlParser::nodeMap, vpMe::setSampleStep(), vpMbtXmlParser::step, and vpXmlParser::xmlReadIntChild().

Referenced by vpMbtXmlParser::read_ecm().

void vpMbtXmlParser::read_sample_deprecated ( xmlDocPtr  doc,
xmlNodePtr  node 
)
inherited

Read sample information.

Exceptions
vpException::fatalErrorif there was an unexpected number of data.
Parameters
doc: Pointer to the document.
node: Pointer to the node of the sample information.

Definition at line 308 of file vpMbtXmlParser.cpp.

References vpMe::getSampleStep(), vpMbtXmlParser::m_ecm, vpXmlParser::nodeMap, vpMe::setSampleStep(), vpMbtXmlParser::step, and vpXmlParser::xmlReadIntChild().

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

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

Definition at line 114 of file vpMbtEdgeKltXmlParser.cpp.

References vpMbXmlParser::angleAppear, vpMbXmlParser::angleDisappear, vpMbtKltXmlParser::blockSize, vpMbXmlParser::cam, camera, ecm, face, vpCameraParameters::get_px(), vpCameraParameters::get_py(), vpCameraParameters::get_u0(), vpCameraParameters::get_v0(), vpMe::getMaskNumber(), vpMe::getMaskSize(), vpMe::getMu1(), vpMe::getMu2(), vpMe::getRange(), vpMe::getSampleStep(), vpMe::getThreshold(), vpMbtKltXmlParser::harrisParam, klt, lod, vpMbtXmlParser::m_ecm, vpMbtKltXmlParser::maskBorder, vpMbtKltXmlParser::maxFeatures, vpMbtKltXmlParser::minDist, vpMbXmlParser::minLineLengthThreshold, vpMbXmlParser::minPolygonAreaThreshold, vpXmlParser::nodeMap, vpMbtKltXmlParser::pyramidLevels, vpMbtKltXmlParser::qualityValue, vpMbXmlParser::read_camera(), vpMbtXmlParser::read_ecm(), vpMbXmlParser::read_face(), vpMbtKltXmlParser::read_klt(), vpMbXmlParser::read_lod(), vpMbtXmlParser::read_sample_deprecated(), vpMbtXmlParser::sample, vpMbXmlParser::useLod, and vpMbtKltXmlParser::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 372 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 207 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 214 of file vpMbXmlParser.h.

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

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

Set the size of a block.

Parameters
bs: New blockSize

Definition at line 166 of file vpMbtKltXmlParser.h.

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

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

Definition at line 216 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 223 of file vpMbXmlParser.h.

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

Set the Harris free parameter.

Parameters
hp: New harrisParam

Definition at line 173 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 276 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 267 of file vpXmlParser.h.

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

Set the Border of the mask.

Parameters
mb= new maskBorder

Definition at line 180 of file vpMbtKltXmlParser.h.

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

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

Set the maximum number of features for the KLT.

Parameters
mF: New maxFeatures

Definition at line 187 of file vpMbtKltXmlParser.h.

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

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

Set the minimum distance between KLT points.

Parameters
mD: New minDist

Definition at line 194 of file vpMbtKltXmlParser.h.

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

void vpMbtXmlParser::setMovingEdge ( const vpMe &  _ecm)
inlineinherited

Definition at line 106 of file vpMbtXmlParser.h.

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

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

Set the near clipping distance.

Parameters
nclip: New nearClipping

Definition at line 230 of file vpMbXmlParser.h.

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

Set the number of pyramid levels

Parameters
pL: New pyramidLevels

Definition at line 201 of file vpMbtKltXmlParser.h.

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

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

Set the quality of the KLT.

Parameters
q: New quality

Definition at line 208 of file vpMbtKltXmlParser.h.

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

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

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

Parameters
w: New winSize

Definition at line 215 of file vpMbtKltXmlParser.h.

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

void vpMbtEdgeKltXmlParser::writeMainClass ( xmlNodePtr  node)
virtual

Write info to file.

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

Implements vpXmlParser.

Definition at line 101 of file vpMbtEdgeKltXmlParser.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 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 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 220 of file vpXmlParser.cpp.

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

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

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 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 vpMbtKltXmlParser::read_klt(), vpMbtXmlParser::read_mask(), and vpMbtXmlParser::read_range().

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 250 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 316 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 281 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 265 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 298 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(), readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::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(), readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and vpMbXmlParser::readMainClass().

unsigned int vpMbtKltXmlParser::blockSize
protectedinherited

Block size.

Definition at line 77 of file vpMbtKltXmlParser.h.

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

vpCameraParameters vpMbXmlParser::cam
protectedinherited

Camera parameters.

Definition at line 67 of file vpMbXmlParser.h.

Referenced by vpMbXmlParser::read_camera(), readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::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
protectedinherited

Harris free parameters.

Definition at line 75 of file vpMbtKltXmlParser.h.

Referenced by vpMbtKltXmlParser::read_klt(), readMainClass(), and vpMbtKltXmlParser::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().

vpMe vpMbtXmlParser::m_ecm
protectedinherited

Moving edges parameters.

Definition at line 86 of file vpMbtXmlParser.h.

Referenced by vpMbtXmlParser::read_contrast(), vpMbtXmlParser::read_ecm(), vpMbtXmlParser::read_mask(), vpMbtXmlParser::read_range(), vpMbtXmlParser::read_sample(), vpMbtXmlParser::read_sample_deprecated(), readMainClass(), and vpMbtXmlParser::readMainClass().

std::string vpXmlParser::main_tag
protectedinherited

The name of the main tag for the file to parse

Definition at line 198 of file vpXmlParser.h.

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

unsigned int vpMbtKltXmlParser::maskBorder
protectedinherited

Border of the mask used on Klt points.

Definition at line 65 of file vpMbtKltXmlParser.h.

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

unsigned int vpMbtKltXmlParser::maxFeatures
protectedinherited

Maximum of Klt features.

Definition at line 67 of file vpMbtKltXmlParser.h.

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

double vpMbtKltXmlParser::minDist
protectedinherited

Minimum distance between klt points.

Definition at line 73 of file vpMbtKltXmlParser.h.

Referenced by vpMbtKltXmlParser::read_klt(), readMainClass(), and vpMbtKltXmlParser::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(), readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::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(), readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::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 193 of file vpXmlParser.h.

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

unsigned int vpMbtKltXmlParser::pyramidLevels
protectedinherited

Number of pyramid levels.

Definition at line 79 of file vpMbtKltXmlParser.h.

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

double vpMbtKltXmlParser::qualityValue
protectedinherited

Quality of the Klt points.

Definition at line 71 of file vpMbtKltXmlParser.h.

Referenced by vpMbtKltXmlParser::read_klt(), readMainClass(), and vpMbtKltXmlParser::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(), readMainClass(), vpMbtXmlParser::readMainClass(), vpMbtKltXmlParser::readMainClass(), and vpMbXmlParser::readMainClass().

unsigned int vpMbtKltXmlParser::winSize
protectedinherited

Windows size.

Definition at line 69 of file vpMbtKltXmlParser.h.

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