Visual Servoing Platform  version 3.2.1 under development (2019-08-19)

#include <visp3/mbt/vpMbEdgeTracker.h>

+ Inheritance diagram for vpMbEdgeTracker:

Public Types

enum  vpMbtOptimizationMethod { GAUSS_NEWTON_OPT = 0, LEVENBERG_MARQUARDT_OPT = 1 }
 

Public Member Functions

 vpMbEdgeTracker ()
 
virtual ~vpMbEdgeTracker ()
 
Inherited functionalities from vpMbEdgeTracker
virtual void display (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, const vpColor &col, const unsigned int thickness=1, const bool displayFullModel=false)
 
virtual void display (const vpImage< vpRGBa > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, const vpColor &col, const unsigned int thickness=1, const bool displayFullModel=false)
 
void getLline (std::list< vpMbtDistanceLine *> &linesList, const unsigned int level=0) const
 
void getLcircle (std::list< vpMbtDistanceCircle *> &circlesList, const unsigned int level=0) const
 
void getLcylinder (std::list< vpMbtDistanceCylinder *> &cylindersList, const unsigned int level=0) const
 
virtual std::vector< std::vector< double > > getModelForDisplay (unsigned int width, unsigned int height, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, const bool displayFullModel=false)
 
virtual void getMovingEdge (vpMe &p_me) const
 
virtual vpMe getMovingEdge () const
 
virtual unsigned int getNbPoints (const unsigned int level=0) const
 
std::vector< bool > getScales () const
 
double getGoodMovingEdgesRatioThreshold () const
 
virtual vpColVector getError () const
 
virtual vpColVector getRobustWeights () const
 
void loadConfigFile (const std::string &configFile)
 
virtual void reInitModel (const vpImage< unsigned char > &I, const std::string &cad_name, const vpHomogeneousMatrix &cMo_, const bool verbose=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
 
void resetTracker ()
 
virtual void setCameraParameters (const vpCameraParameters &camera)
 
virtual void setClipping (const unsigned int &flags)
 
virtual void setFarClippingDistance (const double &dist)
 
virtual void setNearClippingDistance (const double &dist)
 
virtual void setOgreVisibilityTest (const bool &v)
 
virtual void setScanLineVisibilityTest (const bool &v)
 
void setGoodMovingEdgesRatioThreshold (const double threshold)
 
void setMovingEdge (const vpMe &me)
 
virtual void setPose (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cdMo)
 
virtual void setPose (const vpImage< vpRGBa > &I_color, const vpHomogeneousMatrix &cdMo)
 
void setScales (const std::vector< bool > &_scales)
 
void setUseEdgeTracking (const std::string &name, const bool &useEdgeTracking)
 
virtual void track (const vpImage< unsigned char > &I)
 
virtual void track (const vpImage< vpRGBa > &I)
 
Inherited functionalities from vpMbTracker
virtual double computeCurrentProjectionError (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &_cMo, const vpCameraParameters &_cam)
 
virtual double getAngleAppear () const
 
virtual double getAngleDisappear () const
 
virtual void getCameraParameters (vpCameraParameters &camera) const
 
virtual unsigned int getClipping () const
 
virtual vpMatrix getCovarianceMatrix () const
 
virtual double getInitialMu () const
 
virtual double getLambda () const
 
virtual unsigned int getMaxIter () const
 
virtual double getProjectionError () const
 
virtual vpColVector getEstimatedDoF () const
 
virtual vpMbHiddenFaces< vpMbtPolygon > & getFaces ()
 
virtual double getFarClippingDistance () const
 
virtual unsigned int getNbPolygon () const
 
virtual double getNearClippingDistance () const
 
virtual vpMbtOptimizationMethod getOptimizationMethod () const
 
virtual vpMbtPolygongetPolygon (const unsigned int index)
 
virtual std::pair< std::vector< vpPolygon >, std::vector< std::vector< vpPoint > > > getPolygonFaces (const bool orderPolygons=true, const bool useVisibility=true, const bool clipPolygon=false)
 
virtual void getPose (vpHomogeneousMatrix &cMo_) const
 
virtual vpHomogeneousMatrix getPose () const
 
virtual double getStopCriteriaEpsilon () const
 
virtual void initClick (const vpImage< unsigned char > &I, const std::string &initFile, const bool displayHelp=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
 
virtual void initClick (const vpImage< vpRGBa > &I_color, const std::string &initFile, const bool displayHelp=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
 
virtual void initClick (const vpImage< unsigned char > &I, const std::vector< vpPoint > &points3D_list, const std::string &displayFile="")
 
virtual void initClick (const vpImage< vpRGBa > &I_color, const std::vector< vpPoint > &points3D_list, const std::string &displayFile="")
 
virtual void initFromPoints (const vpImage< unsigned char > &I, const std::string &initFile)
 
virtual void initFromPoints (const vpImage< vpRGBa > &I_color, const std::string &initFile)
 
virtual void initFromPoints (const vpImage< unsigned char > &I, const std::vector< vpImagePoint > &points2D_list, const std::vector< vpPoint > &points3D_list)
 
virtual void initFromPoints (const vpImage< vpRGBa > &I_color, const std::vector< vpImagePoint > &points2D_list, const std::vector< vpPoint > &points3D_list)
 
virtual void initFromPose (const vpImage< unsigned char > &I, const std::string &initFile)
 
virtual void initFromPose (const vpImage< vpRGBa > &I_color, const std::string &initFile)
 
virtual void initFromPose (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo)
 
virtual void initFromPose (const vpImage< vpRGBa > &I_color, const vpHomogeneousMatrix &cMo)
 
virtual void initFromPose (const vpImage< unsigned char > &I, const vpPoseVector &cPo)
 
virtual void initFromPose (const vpImage< vpRGBa > &I_color, const vpPoseVector &cPo)
 
virtual void loadModel (const std::string &modelFile, const bool verbose=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
 
virtual void setAngleAppear (const double &a)
 
virtual void setAngleDisappear (const double &a)
 
virtual void setCovarianceComputation (const bool &flag)
 
virtual void setDisplayFeatures (const bool displayF)
 
virtual void setEstimatedDoF (const vpColVector &v)
 
virtual void setInitialMu (const double mu)
 
virtual void setLambda (const double gain)
 
virtual void setLod (const bool useLod, const std::string &name="")
 
virtual void setMaxIter (const unsigned int max)
 
virtual void setMinLineLengthThresh (const double minLineLengthThresh, const std::string &name="")
 
virtual void setMinPolygonAreaThresh (const double minPolygonAreaThresh, const std::string &name="")
 
virtual void setOptimizationMethod (const vpMbtOptimizationMethod &opt)
 
void setProjectionErrorMovingEdge (const vpMe &me)
 
void setProjectionErrorKernelSize (const unsigned int &size)
 
virtual void setMask (const vpImage< bool > &mask)
 
virtual void setStopCriteriaEpsilon (const double eps)
 
virtual void setProjectionErrorComputation (const bool &flag)
 
virtual void setProjectionErrorDisplay (const bool display)
 
virtual void setProjectionErrorDisplayArrowLength (const unsigned int length)
 
virtual void setProjectionErrorDisplayArrowThickness (const unsigned int thickness)
 
void savePose (const std::string &filename) const
 
virtual void setGoodNbRayCastingAttemptsRatio (const double &ratio)
 
virtual void setNbRayCastingAttemptsForVisibility (const unsigned int &attempts)
 
virtual void setOgreShowConfigDialog (const bool showConfigDialog)
 
void setPoseSavingFilename (const std::string &filename)
 

Protected Member Functions

Protected Member Functions Inherited from vpMbEdgeTracker
void addCircle (const vpPoint &P1, const vpPoint &P2, const vpPoint &P3, const double r, int idFace=-1, const std::string &name="")
 
void addCylinder (const vpPoint &P1, const vpPoint &P2, const double r, int idFace=-1, const std::string &name="")
 
void addLine (vpPoint &p1, vpPoint &p2, int polygon=-1, std::string name="")
 
void addPolygon (vpMbtPolygon &p)
 
void cleanPyramid (std::vector< const vpImage< unsigned char > *> &_pyramid)
 
void computeProjectionError (const vpImage< unsigned char > &_I)
 
void computeVVS (const vpImage< unsigned char > &_I, const unsigned int lvl)
 
void computeVVSFirstPhase (const vpImage< unsigned char > &I, const unsigned int iter, double &count, const unsigned int lvl=0)
 
void computeVVSFirstPhaseFactor (const vpImage< unsigned char > &I, const unsigned int lvl=0)
 
void computeVVSFirstPhasePoseEstimation (const unsigned int iter, bool &isoJoIdentity_)
 
virtual void computeVVSInit ()
 
virtual void computeVVSInteractionMatrixAndResidu ()
 
virtual void computeVVSInteractionMatrixAndResidu (const vpImage< unsigned char > &I)
 
virtual void computeVVSWeights ()
 
void displayFeaturesOnImage (const vpImage< unsigned char > &I)
 
void displayFeaturesOnImage (const vpImage< vpRGBa > &I)
 
void downScale (const unsigned int _scale)
 
virtual std::vector< std::vector< double > > getFeaturesForDisplayEdge ()
 
virtual void init (const vpImage< unsigned char > &I)
 
virtual void initCircle (const vpPoint &p1, const vpPoint &p2, const vpPoint &p3, const double radius, const int idFace=0, const std::string &name="")
 
virtual void initCylinder (const vpPoint &p1, const vpPoint &p2, const double radius, const int idFace=0, const std::string &name="")
 
virtual void initFaceFromCorners (vpMbtPolygon &polygon)
 
virtual void initFaceFromLines (vpMbtPolygon &polygon)
 
unsigned int initMbtTracking (unsigned int &nberrors_lines, unsigned int &nberrors_cylinders, unsigned int &nberrors_circles)
 
void initMovingEdge (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &_cMo)
 
void initPyramid (const vpImage< unsigned char > &_I, std::vector< const vpImage< unsigned char > *> &_pyramid)
 
void reInitLevel (const unsigned int _lvl)
 
void reinitMovingEdge (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &_cMo)
 
void removeCircle (const std::string &name)
 
void removeCylinder (const std::string &name)
 
void removeLine (const std::string &name)
 
void resetMovingEdge ()
 
virtual void testTracking ()
 
void trackMovingEdge (const vpImage< unsigned char > &I)
 
void updateMovingEdge (const vpImage< unsigned char > &I)
 
void updateMovingEdgeWeights ()
 
void upScale (const unsigned int _scale)
 
void visibleFace (const vpImage< unsigned char > &_I, const vpHomogeneousMatrix &_cMo, bool &newvisibleline)
 
Protected Member Functions Inherited from vpMbTracker
virtual void initClick (const vpImage< unsigned char > *const I, const vpImage< vpRGBa > *const I_color, const std::string &initFile, const bool displayHelp=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
 
virtual void initClick (const vpImage< unsigned char > *const I, const vpImage< vpRGBa > *const I_color, const std::vector< vpPoint > &points3D_list, const std::string &displayFile="")
 
virtual void initFromPoints (const vpImage< unsigned char > *const I, const vpImage< vpRGBa > *const I_color, const std::string &initFile)
 
virtual void initFromPoints (const vpImage< unsigned char > *const I, const vpImage< vpRGBa > *const I_color, const std::vector< vpImagePoint > &points2D_list, const std::vector< vpPoint > &points3D_list)
 
virtual void initFromPose (const vpImage< unsigned char > *const I, const vpImage< vpRGBa > *const I_color, const std::string &initFile)
 
void addPolygon (const std::vector< vpPoint > &corners, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minPolygonAreaThreshold=2500.0, const double minLineLengthThreshold=50.0)
 
void addPolygon (const vpPoint &p1, const vpPoint &p2, const vpPoint &p3, const double radius, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minPolygonAreaThreshold=2500.0)
 
void addPolygon (const vpPoint &p1, const vpPoint &p2, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minLineLengthThreshold=50)
 
void addPolygon (const std::vector< std::vector< vpPoint > > &listFaces, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minLineLengthThreshold=50)
 
void addProjectionErrorCircle (const vpPoint &P1, const vpPoint &P2, const vpPoint &P3, const double r, int idFace=-1, const std::string &name="")
 
void addProjectionErrorCylinder (const vpPoint &P1, const vpPoint &P2, const double r, int idFace=-1, const std::string &name="")
 
void addProjectionErrorLine (vpPoint &p1, vpPoint &p2, int polygon=-1, std::string name="")
 
void addProjectionErrorPolygon (const std::vector< vpPoint > &corners, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minPolygonAreaThreshold=2500.0, const double minLineLengthThreshold=50.0)
 
void addProjectionErrorPolygon (const vpPoint &p1, const vpPoint &p2, const vpPoint &p3, const double radius, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minPolygonAreaThreshold=2500.0)
 
void addProjectionErrorPolygon (const vpPoint &p1, const vpPoint &p2, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minLineLengthThreshold=50)
 
void addProjectionErrorPolygon (const std::vector< std::vector< vpPoint > > &listFaces, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minLineLengthThreshold=50)
 
void createCylinderBBox (const vpPoint &p1, const vpPoint &p2, const double &radius, std::vector< std::vector< vpPoint > > &listFaces)
 
virtual void computeCovarianceMatrixVVS (const bool isoJoIdentity_, const vpColVector &w_true, const vpHomogeneousMatrix &cMoPrev, const vpMatrix &L_true, const vpMatrix &LVJ_true, const vpColVector &error)
 
void computeJTR (const vpMatrix &J, const vpColVector &R, vpColVector &JTR) const
 
double computeProjectionErrorImpl (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &_cMo, const vpCameraParameters &_cam, unsigned int &nbFeatures)
 
virtual void computeVVSCheckLevenbergMarquardt (const unsigned int iter, vpColVector &error, const vpColVector &m_error_prev, const vpHomogeneousMatrix &cMoPrev, double &mu, bool &reStartFromLastIncrement, vpColVector *const w=NULL, const vpColVector *const m_w_prev=NULL)
 
virtual void computeVVSPoseEstimation (const bool isoJoIdentity_, const unsigned int iter, vpMatrix &L, vpMatrix &LTL, vpColVector &R, const vpColVector &error, vpColVector &error_prev, vpColVector &LTR, double &mu, vpColVector &v, const vpColVector *const w=NULL, vpColVector *const m_w_prev=NULL)
 
virtual void computeVVSWeights (vpRobust &robust, const vpColVector &error, vpColVector &w)
 
virtual void extractGroup (SoVRMLGroup *sceneGraphVRML2, vpHomogeneousMatrix &transform, int &idFace)
 
virtual void extractFaces (SoVRMLIndexedFaceSet *face_set, vpHomogeneousMatrix &transform, int &idFace, const std::string &polygonName="")
 
virtual void extractLines (SoVRMLIndexedLineSet *line_set, int &idFace, const std::string &polygonName="")
 
virtual void extractCylinders (SoVRMLIndexedFaceSet *face_set, vpHomogeneousMatrix &transform, int &idFace, const std::string &polygonName="")
 
vpPoint getGravityCenter (const std::vector< vpPoint > &_pts) const
 
void initProjectionErrorCircle (const vpPoint &p1, const vpPoint &p2, const vpPoint &p3, const double radius, const int idFace=0, const std::string &name="")
 
void initProjectionErrorCylinder (const vpPoint &p1, const vpPoint &p2, const double radius, const int idFace=0, const std::string &name="")
 
void initProjectionErrorFaceFromCorners (vpMbtPolygon &polygon)
 
void initProjectionErrorFaceFromLines (vpMbtPolygon &polygon)
 
virtual void loadVRMLModel (const std::string &modelFile)
 
virtual void loadCAOModel (const std::string &modelFile, std::vector< std::string > &vectorOfModelFilename, int &startIdFace, const bool verbose=false, const bool parent=true, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
 
void projectionErrorInitMovingEdge (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &_cMo)
 
void projectionErrorResetMovingEdges ()
 
void projectionErrorVisibleFace (unsigned int width, unsigned int height, const vpHomogeneousMatrix &_cMo)
 
void removeComment (std::ifstream &fileId)
 
std::map< std::string, std::string > parseParameters (std::string &endLine)
 
bool samePoint (const vpPoint &P1, const vpPoint &P2) const
 

Protected Attributes

vpMe me
 
std::vector< std::list< vpMbtDistanceLine * > > lines
 
std::vector< std::list< vpMbtDistanceCircle * > > circles
 
std::vector< std::list< vpMbtDistanceCylinder * > > cylinders
 
unsigned int nline
 
unsigned int ncircle
 
unsigned int ncylinder
 
unsigned int nbvisiblepolygone
 
double percentageGdPt
 
std::vector< bool > scales
 
std::vector< const vpImage< unsigned char > * > Ipyramid
 
unsigned int scaleLevel
 
unsigned int nbFeaturesForProjErrorComputation
 
vpColVector m_factor
 
vpRobust m_robustLines
 
vpRobust m_robustCylinders
 
vpRobust m_robustCircles
 
vpColVector m_wLines
 
vpColVector m_wCylinders
 
vpColVector m_wCircles
 
vpColVector m_errorLines
 
vpColVector m_errorCylinders
 
vpColVector m_errorCircles
 
vpMatrix m_L_edge
 
vpColVector m_error_edge
 
vpColVector m_w_edge
 
vpColVector m_weightedError_edge
 
vpRobust m_robust_edge
 
std::vector< std::vector< double > > m_featuresToBeDisplayedEdge
 
vpCameraParameters cam
 
vpHomogeneousMatrix cMo
 
vpMatrix oJo
 
bool isoJoIdentity
 
std::string modelFileName
 
bool modelInitialised
 
std::string poseSavingFilename
 
bool computeCovariance
 
vpMatrix covarianceMatrix
 
bool computeProjError
 
double projectionError
 
bool displayFeatures
 
vpMbtOptimizationMethod m_optimizationMethod
 
vpMbHiddenFaces< vpMbtPolygonfaces
 
double angleAppears
 
double angleDisappears
 
double distNearClip
 
double distFarClip
 
unsigned int clippingFlag
 
bool useOgre
 
bool ogreShowConfigDialog
 
bool useScanLine
 
unsigned int nbPoints
 
unsigned int nbLines
 
unsigned int nbPolygonLines
 
unsigned int nbPolygonPoints
 
unsigned int nbCylinders
 
unsigned int nbCircles
 
bool useLodGeneral
 
bool applyLodSettingInConfig
 
double minLineLengthThresholdGeneral
 
double minPolygonAreaThresholdGeneral
 
std::map< std::string, std::string > mapOfParameterNames
 
bool m_computeInteraction
 
double m_lambda
 
unsigned int m_maxIter
 
double m_stopCriteriaEpsilon
 
double m_initialMu
 
std::vector< vpMbtDistanceLine * > m_projectionErrorLines
 
std::vector< vpMbtDistanceCylinder * > m_projectionErrorCylinders
 
std::vector< vpMbtDistanceCircle * > m_projectionErrorCircles
 
vpMbHiddenFaces< vpMbtPolygonm_projectionErrorFaces
 
bool m_projectionErrorOgreShowConfigDialog
 
vpMe m_projectionErrorMe
 
unsigned int m_projectionErrorKernelSize
 
vpMatrix m_SobelX
 
vpMatrix m_SobelY
 
bool m_projectionErrorDisplay
 
unsigned int m_projectionErrorDisplayLength
 
unsigned int m_projectionErrorDisplayThickness
 
vpCameraParameters m_projectionErrorCam
 
const vpImage< bool > * m_mask
 
vpImage< unsigned char > m_I
 

Friends

class vpMbEdgeMultiTracker
 
class vpMbEdgeKltMultiTracker
 

Detailed Description

Make the complete tracking of an object by using its CAD model.

Warning
This class is deprecated for user usage. You should rather use the high level vpMbGenericTracker class.

This class allows to track an object or a scene given its 3D model. A video can be found on YouTube https://www.youtube.com/watch?v=UK10KMMJFCI . The Tutorial: Markerless model-based tracking (deprecated) is also a good starting point to use this class.

The tracker requires the knowledge of the 3D model that could be provided in a vrml or in a cao file. The cao format is described in loadCAOModel(). It may also use an xml file used to tune the behavior of the tracker and an init file used to compute the pose at the very first image.

The following code shows the simplest way to use the tracker.

#include <visp3/core/vpCameraParameters.h>
#include <visp3/core/vpHomogeneousMatrix.h>
#include <visp3/core/vpImage.h>
#include <visp3/gui/vpDisplayX.h>
#include <visp3/io/vpImageIo.h>
#include <visp3/mbt/vpMbEdgeTracker.h>
int main()
{
vpMbEdgeTracker tracker; // Create a model based tracker.
vpHomogeneousMatrix cMo; // Pose computed using the tracker.
// Acquire an image
vpImageIo::read(I, "cube.pgm");
#if defined VISP_HAVE_X11
display.init(I,100,100,"Mb Edge Tracker");
#endif
#if defined VISP_HAVE_PUGIXML
tracker.loadConfigFile("cube.xml"); // Load the configuration of the tracker
#endif
tracker.getCameraParameters(cam); // Get the camera parameters used by the tracker (from the configuration file).
tracker.loadModel("cube.cao"); // Load the 3d model in cao format. No 3rd party library is required
// Initialise manually the pose by clicking on the image points associated to the 3d points contained in the
// cube.init file.
tracker.initClick(I, "cube.init");
while(true){
// Acquire a new image
tracker.track(I); // Track the object on this image
tracker.getPose(cMo); // Get the pose
tracker.display(I, cMo, cam, vpColor::darkRed, 1); // Display the model at the computed pose.
}
return 0;
}

For application with large inter-images displacement, multi-scale tracking is also possible, by setting the number of scales used and by activating (or not) them using a vector of booleans, as presented in the following code:

...
vpHomogeneousMatrix cMo; // Pose computed using the tracker.
std::vector< bool > scales(3); //Three scales used
scales.push_back(true); //First scale : active
scales.push_back(false); //Second scale (/2) : not active
scales.push_back(true); //Third scale (/4) : active
tracker.setScales(scales); // Set active scales for multi-scale tracking
tracker.loadConfigFile("cube.xml"); // Load the configuration of the tracker
tracker.getCameraParameters(cam); // Get the camera parameters used by the tracker (from the configuration file).
...

The tracker can also be used without display, in that case the initial pose must be known (object always at the same initial pose for example) or computed using another method:

#include <visp3/core/vpCameraParameters.h>
#include <visp3/core/vpHomogeneousMatrix.h>
#include <visp3/core/vpImage.h>
#include <visp3/io/vpImageIo.h>
#include <visp3/mbt/vpMbEdgeTracker.h>
int main()
{
vpMbEdgeTracker tracker; // Create a model based tracker.
vpHomogeneousMatrix cMo; // Pose used in entry (has to be defined), then computed using the tracker.
//acquire an image
vpImageIo::read(I, "cube.pgm"); // Example of acquisition
#if defined VISP_HAVE_PUGIXML
tracker.loadConfigFile("cube.xml"); // Load the configuration of the tracker
#endif
// load the 3d model, to read .wrl model coin is required, if coin is not installed .cao file can be used.
tracker.loadModel("cube.cao");
tracker.initFromPose(I, cMo); // initialize the tracker with the given pose.
while(true){
// acquire a new image
tracker.track(I); // track the object on this image
tracker.getPose(cMo); // get the pose
}
return 0;
}

Finally it can be used not to track an object but just to display a model at a given pose:

#include <visp3/core/vpCameraParameters.h>
#include <visp3/core/vpHomogeneousMatrix.h>
#include <visp3/core/vpImage.h>
#include <visp3/gui/vpDisplayX.h>
#include <visp3/io/vpImageIo.h>
#include <visp3/mbt/vpMbEdgeTracker.h>
int main()
{
vpMbEdgeTracker tracker; // Create a model based tracker.
vpHomogeneousMatrix cMo; // Pose used to display the model.
// Acquire an image
vpImageIo::read(I, "cube.pgm");
#if defined VISP_HAVE_X11
display.init(I,100,100,"Mb Edge Tracker");
#endif
#if defined VISP_HAVE_PUGIXML
tracker.loadConfigFile("cube.xml"); // Load the configuration of the tracker
#endif
tracker.getCameraParameters(cam); // Get the camera parameters used by the tracker (from the configuration file).
// load the 3d model, to read .wrl model coin is required, if coin is not installed
// .cao file can be used.
tracker.loadModel("cube.cao");
while(true){
// acquire a new image
// Get the pose using any method
tracker.display(I, cMo, cam, vpColor::darkRed, 1, true); // Display the model at the computed pose.
}
return 0;
}
Examples:
mbtEdgeTracking.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-tracker-full.cpp, and tutorial-mb-tracker.cpp.

Definition at line 258 of file vpMbEdgeTracker.h.

Member Enumeration Documentation

◆ vpMbtOptimizationMethod

Enumerator
GAUSS_NEWTON_OPT 
LEVENBERG_MARQUARDT_OPT 

Definition at line 107 of file vpMbTracker.h.

Constructor & Destructor Documentation

◆ vpMbEdgeTracker()

vpMbEdgeTracker::vpMbEdgeTracker ( )

◆ ~vpMbEdgeTracker()

vpMbEdgeTracker::~vpMbEdgeTracker ( )
virtual

Basic destructor useful to deallocate the memory.

Definition at line 86 of file vpMbEdgeTracker.cpp.

References circles, cleanPyramid(), cylinders, Ipyramid, lines, and scales.

Member Function Documentation

◆ addCircle()

void vpMbEdgeTracker::addCircle ( const vpPoint P1,
const vpPoint P2,
const vpPoint P3,
const double  r,
int  idFace = -1,
const std::string &  name = "" 
)
protected

Add a circle to the list of circles.

Parameters
P1: Center of the circle.
P2,P3: Two points on the plane containing the circle. With the center of the circle we have 3 points defining the plane that contains the circle.
r: Radius of the circle.
idFace: Id of the face that is associated to the circle to handle visibility test.
name: the optional name of the circle.

Definition at line 2051 of file vpMbEdgeTracker.cpp.

References vpMbtDistanceCircle::buildFrom(), vpMbTracker::cam, circles, downScale(), vpMbTracker::faces, vpMbtDistanceCircle::hiddenface, vpMbtDistanceCircle::index_polygon, vpMath::maximum(), me, ncircle, vpMbtDistanceCircle::p1, vpMbtDistanceCircle::p2, vpMbtDistanceCircle::p3, vpMbtDistanceCircle::radius, vpMbTracker::samePoint(), scales, vpMbtDistanceCircle::setCameraParameters(), vpMbtDistanceCircle::setIndex(), vpMbtDistanceCircle::setMovingEdge(), vpMbtDistanceCircle::setName(), and upScale().

Referenced by initCircle().

◆ addCylinder()

void vpMbEdgeTracker::addCylinder ( const vpPoint P1,
const vpPoint P2,
const double  r,
int  idFace = -1,
const std::string &  name = "" 
)
protected

◆ addLine()

void vpMbEdgeTracker::addLine ( vpPoint P1,
vpPoint P2,
int  polygon = -1,
std::string  name = "" 
)
protected

◆ addPolygon() [1/5]

void vpMbEdgeTracker::addPolygon ( vpMbtPolygon p)
protected

Add a polygon to the list of polygons.

Parameters
p: The polygon to add.

Definition at line 2198 of file vpMbEdgeTracker.cpp.

References addLine(), vpMbtPolygon::getIndex(), vpPolygon3D::getNbPoint(), and vpPolygon3D::p.

◆ addPolygon() [2/5]

◆ addPolygon() [3/5]

◆ addPolygon() [4/5]

◆ addPolygon() [5/5]

◆ addProjectionErrorCircle()

◆ addProjectionErrorCylinder()

◆ addProjectionErrorLine()

◆ addProjectionErrorPolygon() [1/4]

◆ addProjectionErrorPolygon() [2/4]

◆ addProjectionErrorPolygon() [3/4]

◆ addProjectionErrorPolygon() [4/4]

◆ cleanPyramid()

void vpMbEdgeTracker::cleanPyramid ( std::vector< const vpImage< unsigned char > *> &  _pyramid)
protected

Clean the pyramid of image allocated with the initPyramid() method. The vector has a size equal to zero at the end of the method.

Parameters
_pyramid: The pyramid of image to clean.

Definition at line 2770 of file vpMbEdgeTracker.cpp.

Referenced by vpMbEdgeKltTracker::init(), init(), vpMbEdgeKltTracker::setPose(), track(), and ~vpMbEdgeTracker().

◆ computeCovarianceMatrixVVS()

◆ computeCurrentProjectionError()

double vpMbTracker::computeCurrentProjectionError ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix _cMo,
const vpCameraParameters _cam 
)
virtualinherited

Compute projection error given an input image and camera pose, parameters. This projection error uses locations sampled exactly where the model is projected using the camera pose and intrinsic parameters. You may want to use

See also
setProjectionErrorComputation
getProjectionError

to get a projection error computed at the ME locations after a call to track(). It works similarly to vpMbTracker::getProjectionError function:

Get the error angle between the gradient direction of the model features projected at the resulting pose and their normal. The error is expressed in degree between 0 and 90.

Parameters
I: Input grayscale image.
_cMo: Camera pose.
_cam: Camera parameters.

Reimplemented in vpMbGenericTracker.

Examples:
mbtGenericTrackingDepthOnly.cpp.

Definition at line 3487 of file vpMbTracker.cpp.

References vpMbTracker::computeProjectionErrorImpl(), vpMath::deg(), vpException::fatalError, and vpMbTracker::modelInitialised.

◆ computeJTR()

void vpMbTracker::computeJTR ( const vpMatrix interaction,
const vpColVector error,
vpColVector JTR 
) const
protectedinherited

Compute $ J^T R $, with J the interaction matrix and R the vector of residu.

Exceptions
vpMatrixException::incorrectMatrixSizeErrorif the sizes of the matrices do not allow the computation.
Warning
The JTR vector is resized.
Parameters
interaction: The interaction matrix (size Nx6).
error: The residu vector (size Nx1).
JTR: The resulting JTR column vector (size 6x1).

Definition at line 2854 of file vpMbTracker.cpp.

References vpCPUFeatures::checkSSE2(), vpArray2D< Type >::data, vpArray2D< Type >::getCols(), vpArray2D< Type >::getRows(), vpMatrixException::incorrectMatrixSizeError, and vpColVector::resize().

Referenced by vpMbEdgeMultiTracker::computeVVSFirstPhasePoseEstimation(), computeVVSFirstPhasePoseEstimation(), and vpMbTracker::computeVVSPoseEstimation().

◆ computeProjectionError()

◆ computeProjectionErrorImpl()

double vpMbTracker::computeProjectionErrorImpl ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix _cMo,
const vpCameraParameters _cam,
unsigned int &  nbFeatures 
)
protectedinherited

Definition at line 3504 of file vpMbTracker.cpp.

References vpMbTracker::clippingFlag, vpMbHiddenFaces< PolygonType >::computeClippedPolygons(), vpCameraParameters::computeFov(), vpMbHiddenFaces< PolygonType >::computeScanLineRender(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpMbHiddenFaces< PolygonType >::initOgre(), vpMbHiddenFaces< PolygonType >::isOgreInitialised(), vpMbtDistanceCircle::isTracked(), vpMbtDistanceLine::isTracked(), vpMbtDistanceCylinder::isTracked(), vpMbtDistanceCircle::isVisible(), vpMbtDistanceLine::isVisible(), vpMbtDistanceCylinder::isVisible(), vpMbTracker::m_projectionErrorCam, vpMbTracker::m_projectionErrorCircles, vpMbTracker::m_projectionErrorCylinders, vpMbTracker::m_projectionErrorDisplay, vpMbTracker::m_projectionErrorDisplayLength, vpMbTracker::m_projectionErrorDisplayThickness, vpMbTracker::m_projectionErrorFaces, vpMbTracker::m_projectionErrorLines, vpMbTracker::m_projectionErrorOgreShowConfigDialog, vpMbTracker::m_SobelX, vpMbTracker::m_SobelY, vpMbtDistanceCircle::meEllipse, vpMbtDistanceLine::meline, vpMbtDistanceCylinder::meline1, vpMbtDistanceCylinder::meline2, vpMbTracker::projectionErrorInitMovingEdge(), vpMbTracker::projectionErrorResetMovingEdges(), vpMbTracker::projectionErrorVisibleFace(), vpMbHiddenFaces< PolygonType >::setBackgroundSizeOgre(), vpMbtDistanceCircle::setCameraParameters(), vpMbtDistanceLine::setCameraParameters(), vpMbtDistanceCylinder::setCameraParameters(), vpMbHiddenFaces< PolygonType >::setOgreShowConfigDialog(), vpMbTracker::useOgre, and vpMbTracker::useScanLine.

Referenced by vpMbTracker::computeCurrentProjectionError().

◆ computeVVS()

◆ computeVVSCheckLevenbergMarquardt()

◆ computeVVSFirstPhase()

◆ computeVVSFirstPhaseFactor()

◆ computeVVSFirstPhasePoseEstimation()

◆ computeVVSInit()

◆ computeVVSInteractionMatrixAndResidu() [1/2]

◆ computeVVSInteractionMatrixAndResidu() [2/2]

◆ computeVVSPoseEstimation()

◆ computeVVSWeights() [1/2]

◆ computeVVSWeights() [2/2]

◆ createCylinderBBox()

void vpMbTracker::createCylinderBBox ( const vpPoint p1,
const vpPoint p2,
const double &  radius,
std::vector< std::vector< vpPoint > > &  listFaces 
)
protectedinherited

◆ display() [1/2]

void vpMbEdgeTracker::display ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix cMo_,
const vpCameraParameters camera,
const vpColor col,
const unsigned int  thickness = 1,
const bool  displayFullModel = false 
)
virtual

Display the 3D model from a given position of the camera.

Parameters
I: The image.
cMo_: Pose used to project the 3D model into the image.
camera: The camera parameters.
col: The desired color.
thickness: The thickness of the lines.
displayFullModel: If true, the full model is displayed (even the non visible faces).

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbEdgeKltMultiTracker, and vpMbEdgeMultiTracker.

Examples:
mbtEdgeTracking.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt2-deprecated.cpp, and tutorial-mb-edge-tracker.cpp.

Definition at line 1291 of file vpMbEdgeTracker.cpp.

References vpDisplay::displayEllipse(), vpMbTracker::displayFeatures, displayFeaturesOnImage(), vpDisplay::displayLine(), vpMbHiddenFaces< PolygonType >::displayOgre(), vpMath::equal(), vpMbTracker::faces, vpImage< Type >::getHeight(), getModelForDisplay(), vpImage< Type >::getWidth(), and vpMbTracker::useOgre.

◆ display() [2/2]

void vpMbEdgeTracker::display ( const vpImage< vpRGBa > &  I,
const vpHomogeneousMatrix cMo_,
const vpCameraParameters camera,
const vpColor col,
const unsigned int  thickness = 1,
const bool  displayFullModel = false 
)
virtual

Display the 3D model from a given position of the camera.

Parameters
I: The image.
cMo_: Pose used to project the 3D model into the image.
camera: The camera parameters.
col: The desired color.
thickness: The thickness of the lines.
displayFullModel: If true, the full model is displayed (even the non visible surfaces).

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbEdgeKltMultiTracker, and vpMbEdgeMultiTracker.

Definition at line 1333 of file vpMbEdgeTracker.cpp.

References vpDisplay::displayEllipse(), vpMbTracker::displayFeatures, displayFeaturesOnImage(), vpDisplay::displayLine(), vpMbHiddenFaces< PolygonType >::displayOgre(), vpMath::equal(), vpMbTracker::faces, vpImage< Type >::getHeight(), getModelForDisplay(), vpImage< Type >::getWidth(), and vpMbTracker::useOgre.

◆ displayFeaturesOnImage() [1/2]

◆ displayFeaturesOnImage() [2/2]

◆ downScale()

void vpMbEdgeTracker::downScale ( const unsigned int  _scale)
protected

Modify the camera parameters to have them corresponding to the current scale. The new parameters are divided by $ 2^{\_scale} $.

Parameters
_scale: Scale to use.

Definition at line 2856 of file vpMbEdgeTracker.cpp.

References vpMbTracker::cam, vpCameraParameters::get_K(), vpCameraParameters::initFromCalibrationMatrix(), and scaleLevel.

Referenced by addCircle(), addCylinder(), addLine(), vpMbEdgeKltTracker::init(), init(), setGoodMovingEdgesRatioThreshold(), vpMbEdgeKltTracker::setPose(), vpMbEdgeMultiTracker::track(), and track().

◆ extractCylinders()

void vpMbTracker::extractCylinders ( SoVRMLIndexedFaceSet *  face_set,
vpHomogeneousMatrix transform,
int &  idFace,
const std::string &  polygonName = "" 
)
protectedvirtualinherited

Extract a cylinder to track from the VMRL model. This method calls the initCylinder() method implemented in the child class.

Warning
This method extract cylinder described using an indexed face set not a cylinder set since software such as AC3D or blender export a cylinder using this data type. the object name is used, if it begins with "cyl" then this method is called otherwise the extractFaces() is used.
Parameters
face_set: Pointer to the cylinder in the vrml format.
transform: Transformation matrix applied to the cylinder.
idFace: Id of the face.
polygonNameName of the polygon.

Definition at line 2438 of file vpMbTracker.cpp.

References vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpException::badValue, vpMbTracker::createCylinderBBox(), vpException::dimensionError, vpPoint::get_oX(), vpPoint::get_oY(), vpPoint::get_oZ(), vpMbTracker::getGravityCenter(), vpMbTracker::initCylinder(), vpMbTracker::initProjectionErrorCylinder(), vpMath::maximum(), vpPoint::setWorldCoordinates(), and vpColVector::sumSquare().

Referenced by vpMbTracker::extractGroup().

◆ extractFaces()

void vpMbTracker::extractFaces ( SoVRMLIndexedFaceSet *  face_set,
vpHomogeneousMatrix transform,
int &  idFace,
const std::string &  polygonName = "" 
)
protectedvirtualinherited

Extract a face of the object to track from the VMRL model. This method calls the initFaceFromCorners() method implemented in the child class.

Parameters
face_set: Pointer to the face in the vrml format.
transform: Transformation matrix applied to the face.
idFace: Face id.
polygonNameName of the polygon.

Definition at line 2385 of file vpMbTracker.cpp.

References vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::faces, vpMbHiddenFaces< PolygonType >::getPolygon(), vpMbTracker::initFaceFromCorners(), vpMbTracker::initProjectionErrorFaceFromCorners(), vpMbTracker::m_projectionErrorFaces, and vpPoint::setWorldCoordinates().

Referenced by vpMbTracker::extractGroup().

◆ extractGroup()

void vpMbTracker::extractGroup ( SoVRMLGroup *  sceneGraphVRML2,
vpHomogeneousMatrix transform,
int &  idFace 
)
protectedvirtualinherited

Extract a VRML object Group.

Parameters
sceneGraphVRML2: Current node (either Transform, or Group node).
transform: Transformation matrix for this group.
idFace: Index of the face.

Definition at line 2296 of file vpMbTracker.cpp.

References vpMbTracker::extractCylinders(), vpMbTracker::extractFaces(), and vpMbTracker::extractLines().

Referenced by vpMbTracker::loadVRMLModel().

◆ extractLines()

void vpMbTracker::extractLines ( SoVRMLIndexedLineSet *  line_set,
int &  idFace,
const std::string &  polygonName = "" 
)
protectedvirtualinherited

Extract a line of the object to track from the VMRL model. This method calls the initFaceFromCorners() method implemented in the child class.

Parameters
line_set: Pointer to the line in the vrml format.
idFace: Id of the face.
polygonNameName of the polygon.

Definition at line 2523 of file vpMbTracker.cpp.

References vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::faces, vpMbHiddenFaces< PolygonType >::getPolygon(), vpMbTracker::initFaceFromCorners(), vpMbTracker::initProjectionErrorFaceFromCorners(), vpMbTracker::m_projectionErrorFaces, and vpPoint::setWorldCoordinates().

Referenced by vpMbTracker::extractGroup().

◆ getAngleAppear()

virtual double vpMbTracker::getAngleAppear ( ) const
inlinevirtualinherited

Return the angle used to test polygons appearance.

Definition at line 234 of file vpMbTracker.h.

◆ getAngleDisappear()

virtual double vpMbTracker::getAngleDisappear ( ) const
inlinevirtualinherited

Return the angle used to test polygons disappearance.

Definition at line 237 of file vpMbTracker.h.

◆ getCameraParameters()

◆ getClipping()

◆ getCovarianceMatrix()

virtual vpMatrix vpMbTracker::getCovarianceMatrix ( ) const
inlinevirtualinherited

◆ getError()

virtual vpColVector vpMbEdgeTracker::getError ( ) const
inlinevirtual

Return the error vector $(s-s^*)$ reached after the virtual visual servoing process used to estimate the pose.

The following example shows how to use this function to compute the norm of the residual and the norm of the residual normalized by the number of features that are tracked:

tracker.track(I); std::cout << "Residual: " << sqrt( (tracker.getError()).sumSquare()) << std::endl;
std::cout << "Residual normalized: "
<< sqrt( (tracker.getError()).sumSquare())/tracker.getError().size() << std::endl;
See also
getRobustWeights()

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbEdgeMultiTracker, and vpMbEdgeKltMultiTracker.

Definition at line 389 of file vpMbEdgeTracker.h.

References m_error_edge.

◆ getEstimatedDoF()

vpColVector vpMbTracker::getEstimatedDoF ( ) const
virtualinherited

Get a 1x6 vpColVector representing the estimated degrees of freedom. vpColVector[0] = 1 if translation on X is estimated, 0 otherwise; vpColVector[1] = 1 if translation on Y is estimated, 0 otherwise; vpColVector[2] = 1 if translation on Z is estimated, 0 otherwise; vpColVector[3] = 1 if rotation on X is estimated, 0 otherwise; vpColVector[4] = 1 if rotation on Y is estimated, 0 otherwise; vpColVector[5] = 1 if rotation on Z is estimated, 0 otherwise;

Returns
1x6 vpColVector representing the estimated degrees of freedom.

Definition at line 3005 of file vpMbTracker.cpp.

References vpMbTracker::oJo.

◆ getFaces()

virtual vpMbHiddenFaces<vpMbtPolygon>& vpMbTracker::getFaces ( )
inlinevirtualinherited

◆ getFarClippingDistance()

virtual double vpMbTracker::getFarClippingDistance ( ) const
inlinevirtualinherited

Get the far distance for clipping.

Returns
Far clipping value.

Definition at line 335 of file vpMbTracker.h.

◆ getFeaturesForDisplayEdge()

◆ getGoodMovingEdgesRatioThreshold()

double vpMbEdgeTracker::getGoodMovingEdgesRatioThreshold ( ) const
inline
Returns
The threshold value between 0 and 1 over good moving edges ratio. It allows to decide if the tracker has enough valid moving edges to compute a pose. 1 means that all moving edges should be considered as good to have a valid pose, while 0.1 means that 10% of the moving edge are enough to declare a pose valid.
See also
setGoodMovingEdgesRatioThreshold()

Definition at line 387 of file vpMbEdgeTracker.h.

References percentageGdPt.

◆ getGravityCenter()

vpPoint vpMbTracker::getGravityCenter ( const std::vector< vpPoint > &  pts) const
protectedinherited

Compute the center of gravity of a set of point. This is used in the cylinder extraction to find the center of the circles.

Exceptions
vpException::dimensionErrorif the set is empty.
Parameters
pts: Set of point to extract the center of gravity.
Returns
Center of gravity of the set.

Definition at line 2568 of file vpMbTracker.cpp.

References vpException::dimensionError, vpPoint::get_oX(), and vpPoint::setWorldCoordinates().

Referenced by vpMbTracker::extractCylinders().

◆ getInitialMu()

virtual double vpMbTracker::getInitialMu ( ) const
inlinevirtualinherited

Get the initial value of mu used in the Levenberg Marquardt optimization loop.

Returns
the initial mu value.

Definition at line 280 of file vpMbTracker.h.

◆ getLambda()

virtual double vpMbTracker::getLambda ( ) const
inlinevirtualinherited

Get the value of the gain used to compute the control law.

Returns
the value for the gain.

Definition at line 287 of file vpMbTracker.h.

◆ getLcircle()

void vpMbEdgeTracker::getLcircle ( std::list< vpMbtDistanceCircle *> &  circlesList,
const unsigned int  level = 0 
) const

Get the list of the circles tracked for the specified level. Each circle contains the list of the vpMeSite.

Exceptions
vpException::dimensionErrorif the second parameter does not correspond to an used level.
Parameters
level: Level corresponding to the list to return.
circlesList: The list of the circles of the model.

Definition at line 2838 of file vpMbEdgeTracker.cpp.

References circles, vpException::dimensionError, and scales.

Referenced by vpMbEdgeMultiTracker::getModelForDisplay().

◆ getLcylinder()

void vpMbEdgeTracker::getLcylinder ( std::list< vpMbtDistanceCylinder *> &  cylindersList,
const unsigned int  level = 0 
) const

Get the list of the cylinders tracked for the specified level. Each cylinder contains the list of the vpMeSite.

Exceptions
vpException::dimensionErrorif the second parameter does not correspond to an used level.
Parameters
level: Level corresponding to the list to return.
cylindersList: The list of the cylinders of the model.

Definition at line 2816 of file vpMbEdgeTracker.cpp.

References cylinders, vpException::dimensionError, and scales.

Referenced by vpMbEdgeMultiTracker::getModelForDisplay().

◆ getLline()

void vpMbEdgeTracker::getLline ( std::list< vpMbtDistanceLine *> &  linesList,
const unsigned int  level = 0 
) const

Get the list of the lines tracked for the specified level. Each line contains the list of the vpMeSite.

Exceptions
vpException::dimensionErrorif the second parameter does not correspond to an used level.
Parameters
level: Level corresponding to the list to return.
linesList: The list of the lines of the model.

Definition at line 2794 of file vpMbEdgeTracker.cpp.

References vpException::dimensionError, lines, and scales.

Referenced by vpMbEdgeMultiTracker::getModelForDisplay().

◆ getMaxIter()

virtual unsigned int vpMbTracker::getMaxIter ( ) const
inlinevirtualinherited

Get the maximum number of iterations of the virtual visual servoing stage.

Returns
the number of iteration

Definition at line 294 of file vpMbTracker.h.

◆ getModelForDisplay()

std::vector< std::vector< double > > vpMbEdgeTracker::getModelForDisplay ( unsigned int  width,
unsigned int  height,
const vpHomogeneousMatrix cMo_,
const vpCameraParameters camera,
const bool  displayFullModel = false 
)
virtual

Return a list of primitives parameters to display the model at a given pose and camera parameters.

  • Line parameters are: <primitive id (here 0 for line)>, <pt_start.i()>, <pt_start.j()>, <pt_end.i()>, <pt_end.j()>
  • Ellipse parameters are: <primitive id (here 1 for ellipse)>, <pt_center.i()>, <pt_center.j()>, <mu20>, <mu11>, <mu02>
Parameters
width: Image width.
height: Image height.
cMo_: Pose used to project the 3D model into the image.
camera: The camera parameters.
displayFullModel: If true, the line is displayed even if it is not

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbEdgeKltMultiTracker, and vpMbEdgeMultiTracker.

Definition at line 1410 of file vpMbEdgeTracker.cpp.

References circles, cylinders, lines, scaleLevel, and scales.

Referenced by display(), vpMbEdgeKltTracker::getError(), and vpMbGenericTracker::track().

◆ getMovingEdge() [1/2]

virtual void vpMbEdgeTracker::getMovingEdge ( vpMe p_me) const
inlinevirtual

Get the moving edge parameters.

Parameters
p_me[out] : an instance of the moving edge parameters used by the tracker.

Reimplemented in vpMbEdgeMultiTracker.

Definition at line 362 of file vpMbEdgeTracker.h.

References me.

◆ getMovingEdge() [2/2]

virtual vpMe vpMbEdgeTracker::getMovingEdge ( ) const
inlinevirtual

Get the moving edge parameters.

Returns
an instance of the moving edge parameters used by the tracker.

Reimplemented in vpMbEdgeMultiTracker.

Definition at line 368 of file vpMbEdgeTracker.h.

References vpMbEdgeMultiTracker::getNbPoints(), and me.

Referenced by vpMbEdgeMultiTracker::getModelForDisplay().

◆ getNbPoints()

unsigned int vpMbEdgeTracker::getNbPoints ( const unsigned int  level = 0) const
virtual

Return the number of good points (vpMeSite) tracked. A good point is a vpMeSite with its flag "state" equal to 0. Only these points are used during the virtual visual servoing stage.

Exceptions
vpException::dimensionErrorif level does not represent a used level.
Returns
the number of good points.

Reimplemented in vpMbEdgeMultiTracker.

Definition at line 2512 of file vpMbEdgeTracker.cpp.

References circles, cylinders, vpException::dimensionError, vpMbtDistanceCircle::isTracked(), vpMbtDistanceLine::isTracked(), vpMbtDistanceCylinder::isTracked(), vpMbtDistanceCircle::isVisible(), vpMbtDistanceLine::isVisible(), vpMbtDistanceCylinder::isVisible(), lines, vpMbtDistanceCircle::meEllipse, vpMbtDistanceLine::meline, vpMbtDistanceCylinder::meline1, vpMbtDistanceCylinder::meline2, vpMbtDistanceLine::nbFeature, vpMeSite::NO_SUPPRESSION, and scales.

Referenced by vpMbEdgeMultiTracker::getModelForDisplay().

◆ getNbPolygon()

virtual unsigned int vpMbTracker::getNbPolygon ( ) const
inlinevirtualinherited

◆ getNearClippingDistance()

virtual double vpMbTracker::getNearClippingDistance ( ) const
inlinevirtualinherited

Get the near distance for clipping.

Returns
Near clipping value.

Reimplemented in vpMbEdgeKltTracker.

Definition at line 371 of file vpMbTracker.h.

Referenced by vpMbEdgeKltTracker::getNearClippingDistance().

◆ getOptimizationMethod()

virtual vpMbtOptimizationMethod vpMbTracker::getOptimizationMethod ( ) const
inlinevirtualinherited

Get the optimization method used during the tracking. 0 = Gauss-Newton approach. 1 = Levenberg-Marquardt approach.

Returns
Optimization method.

Definition at line 380 of file vpMbTracker.h.

◆ getPolygon()

virtual vpMbtPolygon* vpMbTracker::getPolygon ( const unsigned int  index)
inlinevirtualinherited

Return the polygon (face) "index".

Exceptions
vpException::dimensionErrorif index does not represent a good polygon.
Parameters
index: Index of the polygon to return.
Returns
Pointer to the polygon index.

Reimplemented in vpMbGenericTracker.

Definition at line 391 of file vpMbTracker.h.

References vpException::dimensionError, and vpMbHiddenFaces< PolygonType >::size().

Referenced by vpMbGenericTracker::getError().

◆ getPolygonFaces()

std::pair< std::vector< vpPolygon >, std::vector< std::vector< vpPoint > > > vpMbTracker::getPolygonFaces ( const bool  orderPolygons = true,
const bool  useVisibility = true,
const bool  clipPolygon = false 
)
virtualinherited

Get the list of polygons faces (a vpPolygon representing the projection of the face in the image and a list of face corners in 3D), with the possibility to order by distance to the camera or to use the visibility check to consider if the polygon face must be retrieved or not.

Parameters
orderPolygons: If true, the resulting list is ordered from the nearest polygon faces to the farther.
useVisibility: If true, only visible faces will be retrieved.
clipPolygon: If true, the polygons will be clipped according to the clipping flags set in vpMbTracker.
Returns
A pair object containing the list of vpPolygon and the list of face corners.

Reimplemented in vpMbGenericTracker.

Examples:
testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-detection-object-mbt-deprecated.cpp, and tutorial-detection-object-mbt2-deprecated.cpp.

Definition at line 2602 of file vpMbTracker.cpp.

References vpMbTracker::cam, vpMbTracker::cMo, vpMbTracker::faces, and vpMbHiddenFaces< PolygonType >::getPolygon().

Referenced by vpMbGenericTracker::getError().

◆ getPose() [1/2]

virtual void vpMbTracker::getPose ( vpHomogeneousMatrix cMo_) const
inlinevirtualinherited

Get the current pose between the object and the camera. cMo is the matrix which can be used to express coordinates from the object frame to camera frame.

Parameters
cMo_: the pose
Examples:
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, and tutorial-mb-tracker.cpp.

Definition at line 410 of file vpMbTracker.h.

◆ getPose() [2/2]

virtual vpHomogeneousMatrix vpMbTracker::getPose ( ) const
inlinevirtualinherited

Get the current pose between the object and the camera. cMo is the matrix which can be used to express coordinates from the object frame to camera frame.

Returns
the current pose

Definition at line 419 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::getError(), vpMbEdgeKltMultiTracker::getNumberOfCameras(), vpMbKltMultiTracker::getNumberOfCameras(), vpMbEdgeMultiTracker::getNumberOfCameras(), vpMbEdgeKltMultiTracker::getPose(), and vpMbEdgeKltMultiTracker::initClick().

◆ getProjectionError()

virtual double vpMbTracker::getProjectionError ( ) const
inlinevirtualinherited

Get the error angle between the gradient direction of the model features projected at the resulting pose and their normal. The error is expressed in degree between 0 and 90. This value is computed if setProjectionErrorComputation() is turned on.

Returns
the value for the error.
See also
setProjectionErrorComputation()
Examples:
mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, tutorial-mb-generic-tracker-live.cpp, and tutorial-mb-generic-tracker-rgbd-realsense.cpp.

Definition at line 306 of file vpMbTracker.h.

◆ getRobustWeights()

virtual vpColVector vpMbEdgeTracker::getRobustWeights ( ) const
inlinevirtual

Return the weights vector $w_i$ computed by the robust scheme.

The following example shows how to use this function to compute the norm of the weighted residual and the norm of the weighted residual normalized by the sum of the weights associated to the features that are tracked:

tracker.track(I);
vpColVector e = tracker.getError();
vpColVector we(w.size());
for(unsigned int i=0; i<w.size(); i++)
we[i] = w[i]*e[i];
std::cout << "Weighted residual: " << sqrt( (we).sumSquare() ) << std::endl;
std::cout << "Weighted residual normalized: " << sqrt( (we).sumSquare() ) / w.sum() << std::endl;
See also
getError()

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbEdgeMultiTracker, and vpMbEdgeKltMultiTracker.

Definition at line 391 of file vpMbEdgeTracker.h.

References vpMbTracker::loadConfigFile(), m_w_edge, vpMbEdgeKltMultiTracker::reInitModel(), and vpMbTracker::resetTracker().

◆ getScales()

std::vector<bool> vpMbEdgeTracker::getScales ( ) const
inline

Return the scales levels used for the tracking.

Returns
The scales levels used for the tracking.

Definition at line 377 of file vpMbEdgeTracker.h.

References scales.

◆ getStopCriteriaEpsilon()

virtual double vpMbTracker::getStopCriteriaEpsilon ( ) const
inlinevirtualinherited

Definition at line 421 of file vpMbTracker.h.

◆ init()

◆ initCircle()

void vpMbEdgeTracker::initCircle ( const vpPoint p1,
const vpPoint p2,
const vpPoint p3,
const double  radius,
const int  idFace = 0,
const std::string &  name = "" 
)
protectedvirtual

Add a circle to track from its center, 3 points (including the center) defining the plane that contain the circle and its radius.

Parameters
p1: Center of the circle.
p2,p3: Two points on the plane containing the circle. With the center of the circle we have 3 points defining the plane that contains the circle.
radius: Radius of the circle.
idFace: Index of the face associated to the circle to handle visibility test.
name: The optional name of the circle.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, and vpMbEdgeKltMultiTracker.

Definition at line 2350 of file vpMbEdgeTracker.cpp.

References addCircle().

Referenced by vpMbEdgeKltMultiTracker::getRobustWeights(), vpMbEdgeKltTracker::initCircle(), vpMbEdgeKltTracker::testTracking(), and vpMbGenericTracker::track().

◆ initClick() [1/6]

void vpMbTracker::initClick ( const vpImage< unsigned char > &  I,
const std::string &  initFile,
const bool  displayHelp = false,
const vpHomogeneousMatrix T = vpHomogeneousMatrix() 
)
virtualinherited

Initialise the tracker by clicking in the image on the pixels that correspond to the 3D points whose coordinates are extracted from a file. In this file, comments starting with # character are allowed. Notice that 3D point coordinates are expressed in meter in the object frame with their X, Y and Z values.

The structure of this file is the following:

# 3D point coordinates
4 # Number of points in the file (minimum is four)
0.01 0.01 0.01 # \
... # | 3D coordinates in the object frame (X, Y, Z)
0.01 -0.01 -0.01 # /
Parameters
I: Input grayscale image where the user has to click.
initFile: File containing the coordinates of at least 4 3D points the user has to click in the image. This file should have .init extension (ie teabox.init).
displayHelp: Optionnal display of an image (.ppm, .pgm, .jpg, .jpeg, .png) that should have the same generic name as the init file (ie teabox.ppm). This image may be used to show where to click. This functionality is only available if visp_io module is used.
T: optional transformation matrix to transform 3D points expressed in the original object frame to the desired object frame.
Exceptions
vpException::ioError: The file specified in initFile doesn't exist.

Reimplemented in vpMbEdgeMultiTracker, vpMbKltMultiTracker, and vpMbEdgeKltMultiTracker.

Examples:
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, and tutorial-mb-tracker.cpp.

Definition at line 548 of file vpMbTracker.cpp.

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), and vpMbTracker::initClick().

◆ initClick() [2/6]

void vpMbTracker::initClick ( const vpImage< vpRGBa > &  I_color,
const std::string &  initFile,
const bool  displayHelp = false,
const vpHomogeneousMatrix T = vpHomogeneousMatrix() 
)
virtualinherited

Initialise the tracker by clicking in the image on the pixels that correspond to the 3D points whose coordinates are extracted from a file. In this file, comments starting with # character are allowed. Notice that 3D point coordinates are expressed in meter in the object frame with their X, Y and Z values.

The structure of this file is the following:

# 3D point coordinates
4 # Number of points in the file (minimum is four)
0.01 0.01 0.01 # \
... # | 3D coordinates in the object frame (X, Y, Z)
0.01 -0.01 -0.01 # /
Parameters
I_color: Input color image where the user has to click.
initFile: File containing the coordinates of at least 4 3D points the user has to click in the image. This file should have .init extension (ie teabox.init).
displayHelp: Optionnal display of an image (.ppm, .pgm, .jpg, .jpeg, .png) that should have the same generic name as the init file (ie teabox.ppm). This image may be used to show where to click. This functionality is only available if visp_io module is used.
T: optional transformation matrix to transform 3D points expressed in the original object frame to the desired object frame.
Exceptions
vpException::ioError: The file specified in initFile doesn't exist.

Definition at line 585 of file vpMbTracker.cpp.

References vpMbTracker::initClick().

◆ initClick() [3/6]

void vpMbTracker::initClick ( const vpImage< unsigned char > &  I,
const std::vector< vpPoint > &  points3D_list,
const std::string &  displayFile = "" 
)
virtualinherited

Initialise the tracker by clicking in the image on the pixels that correspond to the 3D points whose coordinates are given in points3D_list.

Parameters
I: Input grayscale image where the user has to click.
points3D_list: List of at least 4 3D points with coordinates expressed in meters in the object frame.
displayFile: Path to the image used to display the help. This image may be used to show where to click. This functionality is only available if visp_io module is used.

Reimplemented in vpMbEdgeMultiTracker, vpMbKltMultiTracker, and vpMbEdgeKltMultiTracker.

Definition at line 772 of file vpMbTracker.cpp.

References vpMbTracker::initClick().

◆ initClick() [4/6]

void vpMbTracker::initClick ( const vpImage< vpRGBa > &  I_color,
const std::vector< vpPoint > &  points3D_list,
const std::string &  displayFile = "" 
)
virtualinherited

Initialise the tracker by clicking in the image on the pixels that correspond to the 3D points whose coordinates are given in points3D_list.

Parameters
I_color: Input color image where the user has to click.
points3D_list: List of at least 4 3D points with coordinates expressed in meters in the object frame.
displayFile: Path to the image used to display the help. This image may be used to show where to click. This functionality is only available if visp_io module is used.

Definition at line 789 of file vpMbTracker.cpp.

References vpMbTracker::initClick().

◆ initClick() [5/6]

◆ initClick() [6/6]

◆ initCylinder()

void vpMbEdgeTracker::initCylinder ( const vpPoint p1,
const vpPoint p2,
const double  radius,
const int  idFace = 0,
const std::string &  name = "" 
)
protectedvirtual

Add a cylinder to track from two points on the axis (defining the length of the cylinder) and its radius.

Parameters
p1: First point on the axis.
p2: Second point on the axis.
radius: Radius of the cylinder.
idFace: Id of the face that is associated to the cylinder to handle visibility test.
name: The optional name of the cylinder.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, and vpMbEdgeKltMultiTracker.

Definition at line 2366 of file vpMbEdgeTracker.cpp.

References addCylinder().

Referenced by vpMbEdgeKltMultiTracker::getRobustWeights(), vpMbEdgeKltTracker::initCylinder(), vpMbEdgeKltTracker::testTracking(), and vpMbGenericTracker::track().

◆ initFaceFromCorners()

void vpMbEdgeTracker::initFaceFromCorners ( vpMbtPolygon polygon)
protectedvirtual

Add the lines to track from the polygon description. If the polygon has only two points, it defines a single line that is always visible. If it has three or more corners, it defines a face. In that case the visibility of the face is computed in order to track the corresponding lines only if the face is visible.

The id of the polygon is supposed to be set prior calling this function.

This method is called from the loadModel() one to add a face of the object to track.

Parameters
polygon: The polygon describing the set of lines that has to be tracked.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, and vpMbEdgeKltMultiTracker.

Definition at line 2261 of file vpMbEdgeTracker.cpp.

References addLine(), vpMbtPolygon::getIndex(), vpMbtPolygon::getName(), vpPolygon3D::getNbPoint(), and vpPolygon3D::p.

Referenced by vpMbEdgeKltMultiTracker::getRobustWeights(), vpMbEdgeKltTracker::initFaceFromCorners(), vpMbEdgeKltTracker::testTracking(), and vpMbGenericTracker::track().

◆ initFaceFromLines()

void vpMbEdgeTracker::initFaceFromLines ( vpMbtPolygon polygon)
protectedvirtual

Add the lines to track from the polygon description. If the polygon has only two points, it defines a single line that is always visible. If it has three or more corners, it defines a face. In that case the visibility of the face is computed in order to track the corresponding lines only if the face is visible.

The id of the polygon is supposed to be set prior calling this function.

This method is called from the loadModel() one to add a face of the object to track.

Parameters
polygon: The polygon describing the set of lines that has to be tracked.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, and vpMbEdgeKltMultiTracker.

Definition at line 2285 of file vpMbEdgeTracker.cpp.

References addLine(), vpMbtPolygon::getIndex(), vpMbtPolygon::getName(), vpPolygon3D::getNbPoint(), and vpPolygon3D::p.

Referenced by vpMbEdgeKltMultiTracker::getRobustWeights(), vpMbEdgeKltTracker::initFaceFromLines(), vpMbEdgeKltTracker::testTracking(), and vpMbGenericTracker::track().

◆ initFromPoints() [1/6]

void vpMbTracker::initFromPoints ( const vpImage< unsigned char > &  I,
const std::string &  initFile 
)
virtualinherited

Initialise the tracker by reading 3D point coordinates and the corresponding 2D image point coordinates from a file. Comments starting with # character are allowed. 3D point coordinates are expressed in meter in the object frame with X, Y and Z values. 2D point coordinates are expressied in pixel coordinates, with first the line and then the column of the pixel in the image. The structure of this file is the following.

# 3D point coordinates
4 # Number of 3D points in the file (minimum is four)
0.01 0.01 0.01 # \
... # | 3D coordinates in meters in the object frame
0.01 -0.01 -0.01 # /
# corresponding 2D point coordinates
4 # Number of image points in the file (has to be the same
as the number of 3D points)
100 200 # \
... # | 2D coordinates in pixel in the image
50 10 # /
Parameters
I: Input grayscale image
initFile: Path to the file containing all the points.

Definition at line 967 of file vpMbTracker.cpp.

Referenced by vpMbGenericTracker::getRobustWeights(), and vpMbTracker::initFromPoints().

◆ initFromPoints() [2/6]

void vpMbTracker::initFromPoints ( const vpImage< vpRGBa > &  I_color,
const std::string &  initFile 
)
virtualinherited

Initialise the tracker by reading 3D point coordinates and the corresponding 2D image point coordinates from a file. Comments starting with # character are allowed. 3D point coordinates are expressed in meter in the object frame with X, Y and Z values. 2D point coordinates are expressied in pixel coordinates, with first the line and then the column of the pixel in the image. The structure of this file is the following.

# 3D point coordinates
4 # Number of 3D points in the file (minimum is four)
0.01 0.01 0.01 # \
... # | 3D coordinates in meters in the object frame
0.01 -0.01 -0.01 # /
# corresponding 2D point coordinates
4 # Number of image points in the file (has to be the same
as the number of 3D points)
100 200 # \
... # | 2D coordinates in pixel in the image
50 10 # /
Parameters
I_color: Input color image
initFile: Path to the file containing all the points.

Definition at line 996 of file vpMbTracker.cpp.

References vpMbTracker::initFromPoints().

◆ initFromPoints() [3/6]

void vpMbTracker::initFromPoints ( const vpImage< unsigned char > &  I,
const std::vector< vpImagePoint > &  points2D_list,
const std::vector< vpPoint > &  points3D_list 
)
virtualinherited

Initialise the tracking with the list of image points (points2D_list) and the list of corresponding 3D points (object frame) (points3D_list).

Parameters
I: Input grayscale image
points2D_list: List of image points.
points3D_list: List of 3D points (object frame).

Definition at line 1062 of file vpMbTracker.cpp.

References vpMbTracker::initFromPoints().

◆ initFromPoints() [4/6]

void vpMbTracker::initFromPoints ( const vpImage< vpRGBa > &  I_color,
const std::vector< vpImagePoint > &  points2D_list,
const std::vector< vpPoint > &  points3D_list 
)
virtualinherited

Initialise the tracking with the list of image points (points2D_list) and the list of corresponding 3D points (object frame) (points3D_list).

Parameters
I_color: Input color grayscale image
points2D_list: List of image points.
points3D_list: List of 3D points (object frame).

Definition at line 1076 of file vpMbTracker.cpp.

References vpMbTracker::initFromPoints().

◆ initFromPoints() [5/6]

◆ initFromPoints() [6/6]

void vpMbTracker::initFromPoints ( const vpImage< unsigned char > *const  I,
const vpImage< vpRGBa > *const  I_color,
const std::vector< vpImagePoint > &  points2D_list,
const std::vector< vpPoint > &  points3D_list 
)
protectedvirtualinherited

◆ initFromPose() [1/7]

void vpMbTracker::initFromPose ( const vpImage< unsigned char > &  I,
const std::string &  initFile 
)
virtualinherited

Initialise the tracking thanks to the pose in vpPoseVector format, and read in the file initFile. The structure of this file is (without the comments):

// The six value of the pose vector
0.0000 // \
0.0000 // |
1.0000 // | Exemple of value for the pose vector where Z = 1 meter
0.0000 // |
0.0000 // |
0.0000 // /

Where the three firsts lines refer to the translation and the three last to the rotation in thetaU parametrisation (see vpThetaUVector).

Parameters
I: Input grayscale image
initFile: Path to the file containing the pose.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Examples:
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, testKeyPoint-2.cpp, and testKeyPoint-4.cpp.

Definition at line 1135 of file vpMbTracker.cpp.

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), vpMbTracker::initFromPose(), vpMbDepthDenseTracker::reInitModel(), vpMbDepthNormalTracker::reInitModel(), vpMbKltTracker::reInitModel(), and reInitModel().

◆ initFromPose() [2/7]

void vpMbTracker::initFromPose ( const vpImage< vpRGBa > &  I_color,
const std::string &  initFile 
)
virtualinherited

Initialise the tracking thanks to the pose in vpPoseVector format, and read in the file initFile. The structure of this file is (without the comments):

// The six value of the pose vector
0.0000 // \
0.0000 // |
1.0000 // | Exemple of value for the pose vector where Z = 1 meter
0.0000 // |
0.0000 // |
0.0000 // /

Where the three firsts lines refer to the translation and the three last to the rotation in thetaU parametrisation (see vpThetaUVector).

Parameters
I_color: Input color image
initFile: Path to the file containing the pose.

Definition at line 1158 of file vpMbTracker.cpp.

References vpMbTracker::initFromPose().

◆ initFromPose() [3/7]

void vpMbTracker::initFromPose ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix cMo_ 
)
virtualinherited

Initialise the tracking thanks to the pose.

Parameters
I: Input grayscale image
cMo_: Pose matrix.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Definition at line 1169 of file vpMbTracker.cpp.

References vpMbTracker::cMo, and vpMbTracker::init().

◆ initFromPose() [4/7]

void vpMbTracker::initFromPose ( const vpImage< vpRGBa > &  I_color,
const vpHomogeneousMatrix cMo_ 
)
virtualinherited

Initialise the tracking thanks to the pose.

Parameters
I_color: Input color image
cMo_: Pose matrix.

Definition at line 1181 of file vpMbTracker.cpp.

References vpMbTracker::cMo, vpImageConvert::convert(), vpMbTracker::init(), and vpMbTracker::m_I.

◆ initFromPose() [5/7]

void vpMbTracker::initFromPose ( const vpImage< unsigned char > &  I,
const vpPoseVector cPo 
)
virtualinherited

Initialise the tracking thanks to the pose vector.

Parameters
I: Input grayscale image
cPo: Pose vector.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Definition at line 1194 of file vpMbTracker.cpp.

References vpMbTracker::initFromPose().

◆ initFromPose() [6/7]

void vpMbTracker::initFromPose ( const vpImage< vpRGBa > &  I_color,
const vpPoseVector cPo 
)
virtualinherited

Initialise the tracking thanks to the pose vector.

Parameters
I_color: Input color image
cPo: Pose vector.

Definition at line 1206 of file vpMbTracker.cpp.

References vpImageConvert::convert(), vpMbTracker::initFromPose(), and vpMbTracker::m_I.

◆ initFromPose() [7/7]

void vpMbTracker::initFromPose ( const vpImage< unsigned char > *const  I,
const vpImage< vpRGBa > *const  I_color,
const std::string &  initFile 
)
protectedvirtualinherited

◆ initMbtTracking()

◆ initMovingEdge()

void vpMbEdgeTracker::initMovingEdge ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix _cMo 
)
protected

Initialize the moving edge thanks to a given pose of the camera. The 3D model is projected into the image to create moving edges along the lines.

Parameters
I: The image.
_cMo: The pose of the camera used to initialize the moving edges.

Definition at line 1523 of file vpMbEdgeTracker.cpp.

References circles, cylinders, vpMbtDistanceCircle::hiddenface, vpMbtDistanceLine::hiddenface, vpMbtDistanceCylinder::hiddenface, vpMbtDistanceCircle::index_polygon, vpMbtDistanceCylinder::index_polygon, vpMbtDistanceCircle::initMovingEdge(), vpMbtDistanceLine::initMovingEdge(), vpMbtDistanceCylinder::initMovingEdge(), vpMbtDistanceCircle::isTracked(), vpMbtDistanceLine::isTracked(), vpMbtDistanceCylinder::isTracked(), vpMbHiddenFaces< PolygonType >::isVisible(), vpMbtDistanceLine::Lindex_polygon, lines, vpMbTracker::m_mask, vpMbtDistanceCircle::meEllipse, vpMbtDistanceLine::meline, vpMbtDistanceCylinder::meline1, vpMbtDistanceCylinder::meline2, vpMbtDistanceCircle::nbFeature, vpMbtDistanceLine::nbFeature, vpMbtDistanceCylinder::nbFeature, vpMbtDistanceCylinder::nbFeaturel1, vpMbtDistanceCylinder::nbFeaturel2, vpMbtDistanceLine::nbFeatureTotal, scaleLevel, vpMbtDistanceCircle::setVisible(), vpMbtDistanceLine::setVisible(), vpMbtDistanceCylinder::setVisible(), and vpMbtDistanceLine::updateTracked().

Referenced by vpMbEdgeKltTracker::init(), init(), vpMbEdgeKltTracker::postTracking(), vpMbEdgeKltMultiTracker::postTracking(), setGoodMovingEdgesRatioThreshold(), vpMbEdgeKltTracker::setPose(), vpMbGenericTracker::track(), and track().

◆ initProjectionErrorCircle()

void vpMbTracker::initProjectionErrorCircle ( const vpPoint p1,
const vpPoint p2,
const vpPoint p3,
const double  radius,
const int  idFace = 0,
const std::string &  name = "" 
)
protectedinherited

Definition at line 3439 of file vpMbTracker.cpp.

References vpMbTracker::addProjectionErrorCircle().

Referenced by vpMbTracker::loadCAOModel().

◆ initProjectionErrorCylinder()

void vpMbTracker::initProjectionErrorCylinder ( const vpPoint p1,
const vpPoint p2,
const double  radius,
const int  idFace = 0,
const std::string &  name = "" 
)
protectedinherited

◆ initProjectionErrorFaceFromCorners()

void vpMbTracker::initProjectionErrorFaceFromCorners ( vpMbtPolygon polygon)
protectedinherited

◆ initProjectionErrorFaceFromLines()

void vpMbTracker::initProjectionErrorFaceFromLines ( vpMbtPolygon polygon)
protectedinherited

◆ initPyramid()

void vpMbEdgeTracker::initPyramid ( const vpImage< unsigned char > &  _I,
std::vector< const vpImage< unsigned char > *> &  _pyramid 
)
protected

Compute the pyramid of image associated to the image in parameter. The scales computed are the ones corresponding to the scales attribute of the class. If OpenCV is detected, the functions used to computed a smoothed pyramid come from OpenCV, otherwise a simple subsampling (no smoothing, no interpolation) is realized.

Warning
The pyramid contains pointers to vpImage. To properly deallocate the pyramid. All the element but the first (which is a pointer to the input image) must be freed. A proper cleaning is implemented in the cleanPyramid() method.
Parameters
_I: The input image.
_pyramid: The pyramid of image to build from the input image.

Definition at line 2725 of file vpMbEdgeTracker.cpp.

References vpImage< Type >::bitmap, vpImageConvert::convert(), vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), and scales.

Referenced by vpMbEdgeKltTracker::init(), init(), vpMbEdgeMultiTracker::initPyramid(), vpMbEdgeKltTracker::setPose(), and track().

◆ loadCAOModel()

void vpMbTracker::loadCAOModel ( const std::string &  modelFile,
std::vector< std::string > &  vectorOfModelFilename,
int &  startIdFace,
const bool  verbose = false,
const bool  parent = true,
const vpHomogeneousMatrix odTo = vpHomogeneousMatrix() 
)
protectedvirtualinherited

Load a 3D model contained in a *.cao file.

Since ViSP 2.9.1, lines starting with # character are considered as comments. It is also possible to add comment at the end of the lines. No specific character is requested before the comment. In the following example we use "//" but it could be an other character.

Since ViSP 2.9.1, circles are supported.

The structure of the file is :

V1
# Number of points describing the object
8
0.01 0.01 0.01 // point with index 0 \
... // ... | coordinates of the points in the object frame (in m.)
0.01 0.01 0.01 // point with index 7 /
# Number of lines to track.
3
0 2 // line with index 0 \
1 4 // | Index of the points representing the extremitiesof the lines
1 5 // line with index 2 /
# Number of polygon (face) to track using the line previously described
1
3 0 1 2 // Face described as follow : nbLine indexLine1 indexLine2 ... indexLineN
# Number of polygon (face) to track using the points previously described
3
4 0 2 3 4 // Face described as follow : nbPoint IndexPoint1 IndexPoint2 ... IndexPointN
4 1 3 5 7 3 1 5 6
# Number of cylinder
1
6 7 0.05 // Index of the limits points on the axis (used to know the 'height' of the cylinder) and radius of the cyclinder (in m.)
# Number of circle
1
0.5 0 1 2 // radius, index center point, index 2 other points on the plane containing the circle
Parameters
modelFile: Full name of the main *.cao file containing the model.
vectorOfModelFilename: A vector of *.cao files.
startIdFace: Current Id of the face.
verbose: If true, will print additional information with CAO model files which include other CAO model files.
parent: This parameter is set to true when parsing a parent CAO model file, and false when parsing an included CAO model file.
odTo: optional transformation matrix (currently only for .cao) to transform 3D points expressed in the original object frame to the desired object frame.

Definition at line 1689 of file vpMbTracker.cpp.

References vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::applyLodSettingInConfig, vpException::badValue, vpHomogeneousMatrix::buildFrom(), vpIoTools::checkFilename(), vpMbTracker::createCylinderBBox(), vpIoTools::createFilePath(), vpMbTracker::faces, vpIoTools::getAbsolutePathname(), vpIoTools::getName(), vpIoTools::getParent(), vpMbHiddenFaces< PolygonType >::getPolygon(), vpMbTracker::initCircle(), vpMbTracker::initCylinder(), vpMbTracker::initFaceFromCorners(), vpMbTracker::initFaceFromLines(), vpMbTracker::initProjectionErrorCircle(), vpMbTracker::initProjectionErrorCylinder(), vpMbTracker::initProjectionErrorFaceFromCorners(), vpMbTracker::initProjectionErrorFaceFromLines(), vpException::ioError, vpIoTools::isAbsolutePathname(), vpMbTracker::m_projectionErrorFaces, vpMbTracker::minLineLengthThresholdGeneral, vpMbTracker::minPolygonAreaThresholdGeneral, vpMbTracker::nbCircles, vpMbTracker::nbCylinders, vpMbTracker::nbLines, vpMbTracker::nbPoints, vpMbTracker::nbPolygonLines, vpMbTracker::nbPolygonPoints, vpIoTools::parseBoolean(), vpMbTracker::parseParameters(), vpIoTools::path(), vpMath::rad(), vpMbTracker::removeComment(), vpPoint::setWorldCoordinates(), vpIoTools::splitChain(), vpIoTools::trim(), vpMbTracker::useLodGeneral, and vpTRACE.

Referenced by vpMbTracker::loadModel().

◆ loadConfigFile()

void vpMbEdgeTracker::loadConfigFile ( const std::string &  configFile)
virtual

Load the xml configuration file. From the configuration file initialize the parameters corresponding to the objects: moving-edges, camera and visibility angles.

Parameters
configFile: full name of the xml file.
See also
loadConfigFile(const char*)

Reimplemented from vpMbTracker.

Examples:
mbtEdgeTracking.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt2-deprecated.cpp, and tutorial-mb-edge-tracker.cpp.

Definition at line 1224 of file vpMbEdgeTracker.cpp.

References vpMbTracker::angleAppears, vpMbTracker::angleDisappears, vpMbTracker::applyLodSettingInConfig, vpMbTracker::cam, vpMbTracker::clippingFlag, vpMath::deg(), vpMbtXmlGenericParser::EDGE_PARSER, vpPolygon3D::FOV_CLIPPING, vpMbtXmlGenericParser::getAngleAppear(), vpMbtXmlGenericParser::getAngleDisappear(), vpMbtXmlGenericParser::getCameraParameters(), vpMbtXmlGenericParser::getEdgeMe(), vpMbtXmlGenericParser::getFarClippingDistance(), vpMbtXmlGenericParser::getFovClipping(), vpMbtXmlGenericParser::getLodMinLineLengthThreshold(), vpMbtXmlGenericParser::getLodMinPolygonAreaThreshold(), vpMbtXmlGenericParser::getLodState(), vpMbTracker::getNbPolygon(), vpMbtXmlGenericParser::getNearClippingDistance(), vpMbtXmlGenericParser::hasFarClippingDistance(), vpMbtXmlGenericParser::hasNearClippingDistance(), vpException::ioError, vpMbTracker::loadConfigFile(), me, vpMbTracker::minLineLengthThresholdGeneral, vpMbTracker::minPolygonAreaThresholdGeneral, vpMbtXmlGenericParser::parse(), vpMath::rad(), vpMbtXmlGenericParser::setAngleAppear(), vpMbtXmlGenericParser::setAngleDisappear(), vpMbtXmlGenericParser::setCameraParameters(), setCameraParameters(), setClipping(), vpMbtXmlGenericParser::setEdgeMe(), setFarClippingDistance(), vpMbTracker::setLod(), vpMbTracker::setMinLineLengthThresh(), vpMbTracker::setMinPolygonAreaThresh(), setMovingEdge(), setNearClippingDistance(), and vpMbTracker::useLodGeneral.

Referenced by vpMbEdgeKltTracker::getNearClippingDistance(), and vpMbEdgeMultiTracker::getRobustWeights().

◆ loadModel()

void vpMbTracker::loadModel ( const std::string &  modelFile,
const bool  verbose = false,
const vpHomogeneousMatrix odTo = vpHomogeneousMatrix() 
)
virtualinherited

Load a 3D model from the file in parameter. This file must either be a vrml file (.wrl) or a CAO file (.cao). CAO format is described in the loadCAOModel() method.

Warning
When this class is called to load a vrml model, remember that you have to call Call SoDD::finish() before ending the program.
int main()
{
...
#if defined(VISP_HAVE_COIN3D) && (COIN_MAJOR_VERSION >= 2)
SoDB::finish();
#endif
}
Exceptions
vpException::ioErrorif the file cannot be open, or if its extension is not wrl or cao.
Parameters
modelFile: the file containing the the 3D model description. The extension of this file is either .wrl or .cao.
verbose: verbose option to print additional information when loading CAO model files which include other CAO model files.
odTo: optional transformation matrix (currently only for .cao) to transform 3D points expressed in the original object frame to the desired object frame.

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Examples:
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtKltTracking.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, and tutorial-mb-tracker.cpp.

Definition at line 1466 of file vpMbTracker.cpp.

References vpIoTools::checkFilename(), vpMbTracker::faces, vpException::ioError, vpMbTracker::loadCAOModel(), vpMbTracker::loadVRMLModel(), vpMbTracker::modelFileName, vpMbTracker::modelInitialised, vpMbTracker::nbCircles, vpMbTracker::nbCylinders, vpMbTracker::nbLines, vpMbTracker::nbPoints, vpMbTracker::nbPolygonLines, vpMbTracker::nbPolygonPoints, and vpMbHiddenFaces< PolygonType >::size().

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), vpMbDepthDenseTracker::reInitModel(), vpMbDepthNormalTracker::reInitModel(), vpMbEdgeKltTracker::reInitModel(), vpMbKltTracker::reInitModel(), and reInitModel().

◆ loadVRMLModel()

void vpMbTracker::loadVRMLModel ( const std::string &  modelFile)
protectedvirtualinherited

Load the 3D model of the object from a vrml file. Only LineSet and FaceSet are extracted from the vrml file.

Warning
When this class is called, remember that you have to call Call SoDD::finish() before ending the program.
int main()
{
...
#if defined(VISP_HAVE_COIN3D) && (COIN_MAJOR_VERSION >= 2)
SoDB::finish();
#endif
}
The cylinders extracted using this method do not use the Cylinder keyword of vrml since vrml exporter such as Blender or AC3D consider a cylinder as an IndexedFaceSet. To test whether an indexedFaceSet is a cylinder or not, the name of the geometry is read. If the name begins with "cyl" then the faceset is supposed to be a cylinder. For example, the line
geometry DEF cyl_cylinder1 IndexedFaceSet
defines a cylinder named cyl_cylinder1.
Exceptions
vpException::fatalErrorif the file cannot be open.
Parameters
modelFile: The full name of the file containing the 3D model.

Definition at line 1527 of file vpMbTracker.cpp.

References vpMbTracker::extractGroup(), vpMbTracker::faces, vpException::fatalError, vpMbHiddenFaces< PolygonType >::size(), and vpERROR_TRACE.

Referenced by vpMbTracker::loadModel().

◆ parseParameters()

std::map< std::string, std::string > vpMbTracker::parseParameters ( std::string &  endLine)
protectedinherited

Definition at line 1588 of file vpMbTracker.cpp.

References vpMbTracker::mapOfParameterNames, and vpIoTools::trim().

Referenced by vpMbTracker::loadCAOModel().

◆ projectionErrorInitMovingEdge()

◆ projectionErrorResetMovingEdges()

void vpMbTracker::projectionErrorResetMovingEdges ( )
protectedinherited

◆ projectionErrorVisibleFace()

◆ reInitLevel()

void vpMbEdgeTracker::reInitLevel ( const unsigned int  _lvl)
protected

Re initialize the moving edges associated to a given level. This method is used to re-initialize the level if the tracking failed on this level but succeeded on the other one.

Parameters
_lvl: The level to re-initialize.

Definition at line 2899 of file vpMbEdgeTracker.cpp.

References circles, vpMbTracker::cMo, cylinders, Ipyramid, lines, vpMbTracker::m_mask, vpMbtDistanceCircle::reinitMovingEdge(), vpMbtDistanceLine::reinitMovingEdge(), vpMbtDistanceCylinder::reinitMovingEdge(), scaleLevel, trackMovingEdge(), and updateMovingEdge().

Referenced by setGoodMovingEdgesRatioThreshold(), vpMbEdgeMultiTracker::track(), and track().

◆ reInitModel()

void vpMbEdgeTracker::reInitModel ( const vpImage< unsigned char > &  I,
const std::string &  cad_name,
const vpHomogeneousMatrix cMo_,
const bool  verbose = false,
const vpHomogeneousMatrix T = vpHomogeneousMatrix() 
)
virtual

Re-initialize the model used by the tracker.

Parameters
I: The image containing the object to initialize.
cad_name: Path to the file containing the 3D model description.
cMo_: The new vpHomogeneousMatrix between the camera and the new model
verbose: verbose option to print additional information when loading CAO model files which include other CAO model files.
T: optional transformation matrix (currently only for .cao) to transform 3D points expressed in the original object frame to the desired object frame.

Reimplemented in vpMbEdgeKltTracker, vpMbEdgeKltMultiTracker, and vpMbEdgeMultiTracker.

Definition at line 2450 of file vpMbEdgeTracker.cpp.

References circles, vpMbTracker::cMo, cylinders, vpHomogeneousMatrix::eye(), vpMbTracker::faces, vpMbTracker::initFromPose(), lines, vpMbTracker::loadModel(), nbvisiblepolygone, ncircle, ncylinder, nline, vpMbHiddenFaces< PolygonType >::reset(), and scales.

Referenced by vpMbEdgeKltTracker::getNearClippingDistance(), and vpMbEdgeMultiTracker::getRobustWeights().

◆ reinitMovingEdge()

void vpMbEdgeTracker::reinitMovingEdge ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix _cMo 
)
protected

◆ removeCircle()

void vpMbEdgeTracker::removeCircle ( const std::string &  name)
protected

Remove a circle by its name.

Parameters
name: The name of the circle to remove.

Definition at line 2176 of file vpMbEdgeTracker.cpp.

References circles, vpMbtDistanceCircle::getName(), and scales.

Referenced by setGoodMovingEdgesRatioThreshold().

◆ removeComment()

void vpMbTracker::removeComment ( std::ifstream &  fileId)
protectedinherited

Definition at line 1573 of file vpMbTracker.cpp.

References vpException::ioError.

Referenced by vpMbTracker::initClick(), and vpMbTracker::loadCAOModel().

◆ removeCylinder()

void vpMbEdgeTracker::removeCylinder ( const std::string &  name)
protected

Remove a cylinder by its name.

Parameters
name: The name of the cylinder to remove.

Definition at line 2154 of file vpMbEdgeTracker.cpp.

References cylinders, vpMbtDistanceCylinder::getName(), and scales.

Referenced by setGoodMovingEdgesRatioThreshold().

◆ removeLine()

void vpMbEdgeTracker::removeLine ( const std::string &  name)
protected

Remove a line using its name.

Parameters
name: The name of the line to remove.

Definition at line 2024 of file vpMbEdgeTracker.cpp.

References vpMbtDistanceLine::getName(), lines, and scales.

Referenced by setGoodMovingEdgesRatioThreshold().

◆ resetMovingEdge()

void vpMbEdgeTracker::resetMovingEdge ( )
protected

◆ resetTracker()

◆ samePoint()

bool vpMbTracker::samePoint ( const vpPoint P1,
const vpPoint P2 
) const
protectedinherited

Check if two vpPoints are similar.

To be similar : $ (X_1 - X_2)^2 + (Y_1 - Y_2)^2 + (Z_1 - Z_2)^2 < epsilon $.

Parameters
P1: The first point to compare
P2: The second point to compare

Definition at line 3143 of file vpMbTracker.cpp.

References vpPoint::get_oX(), vpPoint::get_oY(), and vpPoint::get_oZ().

Referenced by addCircle(), addCylinder(), addLine(), vpMbTracker::addProjectionErrorCircle(), vpMbTracker::addProjectionErrorCylinder(), and vpMbTracker::addProjectionErrorLine().

◆ savePose()

void vpMbTracker::savePose ( const std::string &  filename) const
inherited

Save the pose in the given filename

Parameters
filename: Path to the file used to save the pose.

Definition at line 1218 of file vpMbTracker.cpp.

References vpPoseVector::buildFrom(), and vpMbTracker::cMo.

Referenced by vpMbTracker::initClick().

◆ setAngleAppear()

virtual void vpMbTracker::setAngleAppear ( const double &  a)
inlinevirtualinherited

◆ setAngleDisappear()

virtual void vpMbTracker::setAngleDisappear ( const double &  a)
inlinevirtualinherited

◆ setCameraParameters()

◆ setClipping()

◆ setCovarianceComputation()

virtual void vpMbTracker::setCovarianceComputation ( const bool &  flag)
inlinevirtualinherited

◆ setDisplayFeatures()

virtual void vpMbTracker::setDisplayFeatures ( const bool  displayF)
inlinevirtualinherited

Enable to display the features. By features, we meant the moving edges (ME) and the klt points if used.

Note that if present, the moving edges can be displayed with different colors:

  • If green : The ME is a good point.
  • If blue : The ME is removed because of a contrast problem during the tracking phase.
  • If purple : The ME is removed because of a threshold problem during the tracking phase.
  • If red : The ME is removed because it is rejected by the robust approach in the virtual visual servoing scheme.
Parameters
displayF: set it to true to display the features.

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Examples:
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt2-deprecated.cpp, tutorial-mb-edge-tracker.cpp, tutorial-mb-hybrid-tracker.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, tutorial-mb-tracker-stereo-mono.cpp, tutorial-mb-tracker-stereo.cpp, and tutorial-mb-tracker.cpp.

Definition at line 513 of file vpMbTracker.h.

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), and vpMbGenericTracker::setDisplayFeatures().

◆ setEstimatedDoF()

void vpMbTracker::setEstimatedDoF ( const vpColVector v)
virtualinherited

Set a 6-dim column vector representing the degrees of freedom in the object frame that are estimated by the tracker. When set to 1, all the 6 dof are estimated.

Below we give the correspondance between the index of the vector and the considered dof:

  • v[0] = 1 if translation along X is estimated, 0 otherwise;
  • v[1] = 1 if translation along Y is estimated, 0 otherwise;
  • v[2] = 1 if translation along Z is estimated, 0 otherwise;
  • v[3] = 1 if rotation along X is estimated, 0 otherwise;
  • v[4] = 1 if rotation along Y is estimated, 0 otherwise;
  • v[5] = 1 if rotation along Z is estimated, 0 otherwise;

Definition at line 3028 of file vpMbTracker.cpp.

References vpArray2D< Type >::getRows(), vpMbTracker::isoJoIdentity, and vpMbTracker::oJo.

◆ setFarClippingDistance()

◆ setGoodMovingEdgesRatioThreshold()

void vpMbEdgeTracker::setGoodMovingEdgesRatioThreshold ( const double  threshold)
inline

Set the threshold value between 0 and 1 over good moving edges ratio. It allows to decide if the tracker has enough valid moving edges to compute a pose. 1 means that all moving edges should be considered as good to have a valid pose, while 0.1 means that 10% of the moving edge are enough to declare a pose valid.

Parameters
threshold: Value between 0 and 1 that corresponds to the ratio of good moving edges that is necessary to consider that the estimated pose is valid. Default value is 0.4.
See also
getGoodMovingEdgesRatioThreshold()

Definition at line 480 of file vpMbEdgeTracker.h.

References vpMbKltMultiTracker::addCircle(), addCylinder(), addLine(), vpMbTracker::addPolygon(), vpMbEdgeMultiTracker::cleanPyramid(), vpMbEdgeMultiTracker::computeProjectionError(), vpMbKltMultiTracker::computeVVS(), computeVVSFirstPhase(), computeVVSFirstPhaseFactor(), vpMbEdgeMultiTracker::computeVVSFirstPhasePoseEstimation(), vpMbTracker::computeVVSInit(), vpMbTracker::computeVVSInteractionMatrixAndResidu(), vpMbTracker::computeVVSWeights(), displayFeaturesOnImage(), downScale(), getFeaturesForDisplayEdge(), vpMbTracker::init(), vpMbTracker::initCircle(), vpMbTracker::initCylinder(), vpMbTracker::initFaceFromCorners(), vpMbTracker::initFaceFromLines(), vpMbEdgeKltMultiTracker::initMbtTracking(), initMovingEdge(), vpMbEdgeMultiTracker::initPyramid(), reInitLevel(), reinitMovingEdge(), removeCircle(), removeCylinder(), removeLine(), resetMovingEdge(), vpMbEdgeMultiTracker::setMovingEdge(), vpMbTracker::setPose(), vpMbEdgeMultiTracker::setScales(), vpMbEdgeMultiTracker::setUseEdgeTracking(), vpMbTracker::testTracking(), vpMbTracker::track(), trackMovingEdge(), updateMovingEdge(), updateMovingEdgeWeights(), upScale(), and visibleFace().

Referenced by vpMbEdgeMultiTracker::getRobustWeights().

◆ setGoodNbRayCastingAttemptsRatio()

virtual void vpMbTracker::setGoodNbRayCastingAttemptsRatio ( const double &  ratio)
inlinevirtualinherited

Set the ratio of visibility attempts that has to be successful to consider a polygon as visible.

See also
setNbRayCastingAttemptsForVisibility(const unsigned int &)
Parameters
ratio: Ratio of succesful attempts that has to be considered. Value has to be between 0.0 (0%) and 1.0 (100%).

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Definition at line 613 of file vpMbTracker.h.

References vpMbHiddenFaces< PolygonType >::setGoodNbRayCastingAttemptsRatio().

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), and vpMbGenericTracker::getRobustWeights().

◆ setInitialMu()

virtual void vpMbTracker::setInitialMu ( const double  mu)
inlinevirtualinherited

Set the initial value of mu for the Levenberg Marquardt optimization loop.

Parameters
mu: initial mu.

Definition at line 524 of file vpMbTracker.h.

◆ setLambda()

virtual void vpMbTracker::setLambda ( const double  gain)
inlinevirtualinherited

Set the value of the gain used to compute the control law.

Parameters
gain: the desired value for the gain.

Definition at line 531 of file vpMbTracker.h.

◆ setLod()

void vpMbTracker::setLod ( const bool  useLod,
const std::string &  name = "" 
)
virtualinherited

Set the flag to consider if the level of detail (LOD) is used.

Parameters
useLod: true if the level of detail must be used, false otherwise. When true, two parameters can be set, see setMinLineLengthThresh() and setMinPolygonAreaThresh().
name: name of the face we want to modify the LOD parameter.
See also
setMinLineLengthThresh(), setMinPolygonAreaThresh()

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Definition at line 2740 of file vpMbTracker.cpp.

References vpMbTracker::faces, and vpMbHiddenFaces< PolygonType >::size().

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), vpMbEdgeKltTracker::loadConfigFile(), vpMbKltTracker::loadConfigFile(), and loadConfigFile().

◆ setMask()

virtual void vpMbTracker::setMask ( const vpImage< bool > &  mask)
inlinevirtualinherited

Reimplemented in vpMbGenericTracker.

Definition at line 559 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::getRobustWeights(), and vpMbGenericTracker::setMask().

◆ setMaxIter()

virtual void vpMbTracker::setMaxIter ( const unsigned int  max)
inlinevirtualinherited

Set the maximum iteration of the virtual visual servoing stage.

Parameters
max: the desired number of iteration

Definition at line 540 of file vpMbTracker.h.

◆ setMinLineLengthThresh()

void vpMbTracker::setMinLineLengthThresh ( const double  minLineLengthThresh,
const std::string &  name = "" 
)
virtualinherited

Set the threshold for the minimum line length to be considered as visible in the LOD case.

Parameters
minLineLengthThresh: threshold for the minimum line length in pixel.
name: name of the face we want to modify the LOD threshold.
See also
setLod(), setMinPolygonAreaThresh()

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Definition at line 2758 of file vpMbTracker.cpp.

References vpMbTracker::faces, and vpMbHiddenFaces< PolygonType >::size().

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), vpMbEdgeKltTracker::loadConfigFile(), vpMbKltTracker::loadConfigFile(), and loadConfigFile().

◆ setMinPolygonAreaThresh()

void vpMbTracker::setMinPolygonAreaThresh ( const double  minPolygonAreaThresh,
const std::string &  name = "" 
)
virtualinherited

Set the minimum polygon area to be considered as visible in the LOD case.

Parameters
minPolygonAreaThresh: threshold for the minimum polygon area in pixel.
name: name of the face we want to modify the LOD threshold.
See also
setLod(), setMinLineLengthThresh()

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Definition at line 2775 of file vpMbTracker.cpp.

References vpMbTracker::faces, and vpMbHiddenFaces< PolygonType >::size().

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), vpMbEdgeKltTracker::loadConfigFile(), vpMbKltTracker::loadConfigFile(), and loadConfigFile().

◆ setMovingEdge()

◆ setNbRayCastingAttemptsForVisibility()

virtual void vpMbTracker::setNbRayCastingAttemptsForVisibility ( const unsigned int &  attempts)
inlinevirtualinherited

Set the number of rays that will be sent toward each polygon for visibility test. Each ray will go from the optic center of the camera to a random point inside the considered polygon.

See also
setGoodNbRayCastingAttemptsRatio(const unsigned int &)
Parameters
attemptsNumber of rays to be sent.

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Definition at line 623 of file vpMbTracker.h.

References vpMbHiddenFaces< PolygonType >::setNbRayCastingAttemptsForVisibility().

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), and vpMbGenericTracker::getRobustWeights().

◆ setNearClippingDistance()

◆ setOgreShowConfigDialog()

virtual void vpMbTracker::setOgreShowConfigDialog ( const bool  showConfigDialog)
inlinevirtualinherited

Enable/Disable the appearance of Ogre config dialog on startup.

Warning
This method has only effect when Ogre is used and Ogre visibility test is enabled using setOgreVisibilityTest() with true parameter.
Parameters
showConfigDialog: if true, shows Ogre dialog window (used to set Ogre rendering options) when Ogre visibility is enabled. By default, this functionality is turned off.

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Examples:
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, mbtKltTracking.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 639 of file vpMbTracker.h.

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), and vpMbGenericTracker::setOgreShowConfigDialog().

◆ setOgreVisibilityTest()

virtual void vpMbEdgeTracker::setOgreVisibilityTest ( const bool &  v)
inlinevirtual

Use Ogre3D for visibility tests

Warning
This function has to be called before the initialization of the tracker.
Parameters
v: True to use it, False otherwise

Reimplemented from vpMbTracker.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbEdgeKltTracker.

Examples:
mbtEdgeTracking.cpp, tutorial-detection-object-mbt-deprecated.cpp, tutorial-detection-object-mbt2-deprecated.cpp, and tutorial-mb-edge-tracker.cpp.

Definition at line 441 of file vpMbEdgeTracker.h.

References vpMbTracker::faces, vpMbHiddenFaces< PolygonType >::getOgreContext(), vpMbTracker::setOgreVisibilityTest(), and vpAROgre::setWindowName().

Referenced by vpMbEdgeMultiTracker::getRobustWeights().

◆ setOptimizationMethod()

virtual void vpMbTracker::setOptimizationMethod ( const vpMbtOptimizationMethod opt)
inlinevirtualinherited

Set the optimization method used during the tracking.

Parameters
opt: Optimization method to use.

Reimplemented in vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

Definition at line 553 of file vpMbTracker.h.

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), and vpMbGenericTracker::setOptimizationMethod().

◆ setPose() [1/2]

void vpMbEdgeTracker::setPose ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix cdMo 
)
virtual

Set the pose to be used in entry of the next call to the track() function. This pose will be just used once.

Parameters
I: grayscale image corresponding to the desired pose.
cdMo: Pose to affect.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbEdgeKltTracker.

Examples:
mbtEdgeTracking.cpp, testKeyPoint-2.cpp, testKeyPoint-4.cpp, tutorial-detection-object-mbt-deprecated.cpp, and tutorial-detection-object-mbt2-deprecated.cpp.

Definition at line 1192 of file vpMbEdgeTracker.cpp.

References vpMbTracker::cMo, and init().

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), and vpMbEdgeKltTracker::setScanLineVisibilityTest().

◆ setPose() [2/2]

void vpMbEdgeTracker::setPose ( const vpImage< vpRGBa > &  I_color,
const vpHomogeneousMatrix cdMo 
)
virtual

Set the pose to be used in entry of the next call to the track() function. This pose will be just used once.

Parameters
I_color: color image corresponding to the desired pose.
cdMo: Pose to affect.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbEdgeKltTracker.

Definition at line 1206 of file vpMbEdgeTracker.cpp.

References vpMbTracker::cMo, vpImageConvert::convert(), init(), and vpMbTracker::m_I.

◆ setPoseSavingFilename()

void vpMbTracker::setPoseSavingFilename ( const std::string &  filename)
inlineinherited

Set the filename used to save the initial pose computed using the initClick() method. It is also used to read a previous pose in the same method. If the file is not set then, the initClick() method will create a .0.pos file in the root directory. This directory is the path to the file given to the method initClick() used to know the coordinates in the object frame.

Parameters
filename: The new filename.

Definition at line 651 of file vpMbTracker.h.

◆ setProjectionErrorComputation()

virtual void vpMbTracker::setProjectionErrorComputation ( const bool &  flag)
inlinevirtualinherited

Set if the projection error criteria has to be computed. This criteria could be used to detect the quality of the tracking. It computes an angle between 0 and 90 degrees that is available with getProjectionError(). Closer to 0 is the value, better is the tracking.

Parameters
flag: True if the projection error criteria has to be computed, false otherwise.
See also
getProjectionError()

Reimplemented in vpMbKltTracker, vpMbGenericTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbEdgeKltTracker.

Examples:
mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, and mbtGenericTrackingDepthOnly.cpp.

Definition at line 580 of file vpMbTracker.h.

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbGenericTracker::getRobustWeights(), vpMbEdgeKltTracker::setProjectionErrorComputation(), vpMbEdgeMultiTracker::setProjectionErrorComputation(), vpMbEdgeKltMultiTracker::setProjectionErrorComputation(), vpMbGenericTracker::setProjectionErrorComputation(), and vpMbGenericTracker::track().

◆ setProjectionErrorDisplay()

virtual void vpMbTracker::setProjectionErrorDisplay ( const bool  display)
inlinevirtualinherited

Display or not gradient and model orientation when computing the projection error.

Reimplemented in vpMbGenericTracker.

Examples:
mbtGenericTrackingDepthOnly.cpp.

Definition at line 585 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::getRobustWeights(), and vpMbGenericTracker::setProjectionErrorDisplay().

◆ setProjectionErrorDisplayArrowLength()

virtual void vpMbTracker::setProjectionErrorDisplayArrowLength ( const unsigned int  length)
inlinevirtualinherited

Arrow length used to display gradient and model orientation for projection error computation.

Reimplemented in vpMbGenericTracker.

Examples:
mbtGenericTrackingDepthOnly.cpp.

Definition at line 590 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::getRobustWeights(), and vpMbGenericTracker::setProjectionErrorDisplayArrowLength().

◆ setProjectionErrorDisplayArrowThickness()

virtual void vpMbTracker::setProjectionErrorDisplayArrowThickness ( const unsigned int  thickness)
inlinevirtualinherited

Arrow thickness used to display gradient and model orientation for projection error computation.

Reimplemented in vpMbGenericTracker.

Examples:
mbtGenericTrackingDepthOnly.cpp.

Definition at line 595 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::getRobustWeights(), and vpMbGenericTracker::setProjectionErrorDisplayArrowThickness().

◆ setProjectionErrorKernelSize()

void vpMbTracker::setProjectionErrorKernelSize ( const unsigned int &  size)
inherited

Set kernel size used for projection error computation.

Parameters
size: Kernel size computed as kernel_size = size*2 + 1.

Definition at line 3841 of file vpMbTracker.cpp.

References vpArray2D< Type >::data, vpImageFilter::getSobelKernelX(), vpImageFilter::getSobelKernelY(), vpMbTracker::m_projectionErrorKernelSize, vpMbTracker::m_SobelX, vpMbTracker::m_SobelY, and vpArray2D< Type >::resize().

Referenced by vpMbTracker::loadConfigFile().

◆ setProjectionErrorMovingEdge()

void vpMbTracker::setProjectionErrorMovingEdge ( const vpMe me)
inherited

◆ setScales()

void vpMbEdgeTracker::setScales ( const std::vector< bool > &  scale)

Set the scales to use to realize the tracking. The vector of boolean activates or not the scales to set for the object tracking. The first element of the list correspond to the tracking on the full image, the second element corresponds to the tracking on an image subsampled by two.

Using multi scale tracking allows to track the object with greater moves. It requires the computation of a pyramid of images, but the total tracking can be faster than a tracking based only on the full scale. The pose is computed from the smallest image to the biggest. This may be dangerous if the object to track is small in the image, because the subsampled scale(s) will have only few points to compute the pose (it could result in a loss of precision).

Warning
This method must be used before the tracker has been initialized ( before the call of the loadConfigFile() or loadModel() methods).
At least one level must be activated.
Parameters
scale: The vector describing the levels to use.

Definition at line 2589 of file vpMbEdgeTracker.cpp.

References circles, cylinders, lines, scales, and vpERROR_TRACE.

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), resetTracker(), and vpMbEdgeMultiTracker::setScales().

◆ setScanLineVisibilityTest()

virtual void vpMbEdgeTracker::setScanLineVisibilityTest ( const bool &  v)
inlinevirtual

Use Scanline algorithm for visibility tests

Parameters
v: True to use it, False otherwise

Reimplemented from vpMbTracker.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbEdgeKltTracker.

Examples:
mbtEdgeTracking.cpp.

Definition at line 454 of file vpMbEdgeTracker.h.

References vpMbTracker::setScanLineVisibilityTest().

Referenced by vpMbEdgeMultiTracker::getRobustWeights(), vpMbEdgeKltTracker::setScanLineVisibilityTest(), and vpMbGenericTracker::track().

◆ setStopCriteriaEpsilon()

virtual void vpMbTracker::setStopCriteriaEpsilon ( const double  eps)
inlinevirtualinherited

Set the minimal error (previous / current estimation) to determine if there is convergence or not.

Parameters
eps: Epsilon threshold.

Definition at line 567 of file vpMbTracker.h.

◆ setUseEdgeTracking()

void vpMbEdgeTracker::setUseEdgeTracking ( const std::string &  name,
const bool &  useEdgeTracking 
)

Set if the polygons that have the given name have to be considered during the tracking phase.

Parameters
name: name of the polygon(s).
useEdgeTracking: True if it has to be considered, False otherwise.

Definition at line 2943 of file vpMbEdgeTracker.cpp.

References circles, cylinders, vpMbTracker::faces, lines, and scales.

Referenced by vpMbEdgeMultiTracker::getRobustWeights().

◆ testTracking()

◆ track() [1/2]

◆ track() [2/2]

void vpMbEdgeTracker::track ( const vpImage< vpRGBa > &  I)
virtual

Track the object in the given image

Parameters
I: The current image.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbEdgeKltTracker.

Definition at line 1124 of file vpMbEdgeTracker.cpp.

References vpImageConvert::convert(), vpMbTracker::m_I, and track().

◆ trackMovingEdge()

◆ updateMovingEdge()

◆ updateMovingEdgeWeights()

◆ upScale()

void vpMbEdgeTracker::upScale ( const unsigned int  _scale)
protected

Modify the camera parameters to have them corresponding to the current scale. The new parameters are multiplied by $ 2^{\_scale} $.

Parameters
_scale: Scale to use.

Definition at line 2877 of file vpMbEdgeTracker.cpp.

References vpMbTracker::cam, vpCameraParameters::get_K(), vpCameraParameters::initFromCalibrationMatrix(), and scaleLevel.

Referenced by addCircle(), addCylinder(), addLine(), vpMbEdgeKltTracker::init(), init(), setGoodMovingEdgesRatioThreshold(), vpMbEdgeKltTracker::setPose(), vpMbEdgeMultiTracker::track(), and track().

◆ visibleFace()

void vpMbEdgeTracker::visibleFace ( const vpImage< unsigned char > &  _I,
const vpHomogeneousMatrix _cMo,
bool &  newvisibleline 
)
protected

Detect the visible faces in the image and says if a new one appeared.

Warning
If in one iteration one face appears and one disappears, then the function will not detect the new face.
Parameters
_I: Image to test if a face is entirely in the image.
_cMo: The pose of the camera used to project the 3D model into the image.
newvisibleline: This parameter is set to true if a new face appeared.

Definition at line 2219 of file vpMbEdgeTracker.cpp.

References vpMbTracker::angleAppears, vpMbTracker::angleDisappears, vpMbTracker::cam, vpMbTracker::faces, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), nbvisiblepolygone, vpMbHiddenFaces< PolygonType >::setVisible(), vpMbHiddenFaces< PolygonType >::setVisibleOgre(), and vpMbTracker::useOgre.

Referenced by init(), vpMbEdgeKltMultiTracker::postTracking(), setGoodMovingEdgesRatioThreshold(), vpMbGenericTracker::track(), and track().

Friends And Related Function Documentation

◆ vpMbEdgeKltMultiTracker

friend class vpMbEdgeKltMultiTracker
friend

Definition at line 261 of file vpMbEdgeTracker.h.

◆ vpMbEdgeMultiTracker

friend class vpMbEdgeMultiTracker
friend

Definition at line 260 of file vpMbEdgeTracker.h.

Member Data Documentation

◆ angleAppears

◆ angleDisappears

◆ applyLodSettingInConfig

bool vpMbTracker::applyLodSettingInConfig
protectedinherited

True if the CAO model is loaded before the call to loadConfigFile, (deduced by the number of polygons)

Definition at line 175 of file vpMbTracker.h.

Referenced by vpMbTracker::loadCAOModel(), vpMbEdgeKltTracker::loadConfigFile(), vpMbKltTracker::loadConfigFile(), loadConfigFile(), and vpMbGenericTracker::track().

◆ cam

vpCameraParameters vpMbTracker::cam
protectedinherited

The camera parameters.

Definition at line 111 of file vpMbTracker.h.

Referenced by vpMbKltTracker::addCircle(), addCircle(), addCylinder(), vpMbDepthDenseTracker::addFace(), vpMbDepthNormalTracker::addFace(), addLine(), vpMbTracker::addProjectionErrorCircle(), vpMbTracker::addProjectionErrorCylinder(), vpMbTracker::addProjectionErrorLine(), vpMbDepthDenseTracker::computeVisibility(), vpMbDepthNormalTracker::computeVisibility(), vpMbEdgeKltTracker::computeVVS(), computeVVSFirstPhase(), vpMbKltTracker::computeVVSInit(), computeVVSInit(), downScale(), vpMbEdgeKltMultiTracker::getCameraParameters(), vpMbDepthNormalTracker::getFeaturesForDisplayDepthNormal(), vpMbKltTracker::getModelForDisplay(), vpMbTracker::getPolygonFaces(), vpMbKltTracker::getRobustWeights(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbKltTracker::init(), init(), vpMbKltMultiTracker::initClick(), vpMbEdgeMultiTracker::initClick(), vpMbTracker::initClick(), vpMbKltTracker::initCylinder(), vpMbKltTracker::initFaceFromCorners(), vpMbKltTracker::initFaceFromLines(), vpMbGenericTracker::initFromPoints(), vpMbTracker::initFromPoints(), vpMbGenericTracker::initFromPose(), vpMbDepthDenseTracker::loadConfigFile(), vpMbDepthNormalTracker::loadConfigFile(), vpMbKltMultiTracker::loadConfigFile(), vpMbEdgeMultiTracker::loadConfigFile(), vpMbEdgeKltTracker::loadConfigFile(), vpMbGenericTracker::loadConfigFile(), loadConfigFile(), vpMbEdgeKltTracker::postTracking(), vpMbKltTracker::postTracking(), vpMbKltTracker::reinit(), vpMbDepthDenseTracker::setCameraParameters(), vpMbDepthNormalTracker::setCameraParameters(), vpMbKltMultiTracker::setCameraParameters(), vpMbEdgeMultiTracker::setCameraParameters(), vpMbEdgeKltMultiTracker::setCameraParameters(), vpMbEdgeKltTracker::setCameraParameters(), vpMbGenericTracker::setCameraParameters(), vpMbKltTracker::setCameraParameters(), setCameraParameters(), vpMbEdgeKltTracker::setPose(), vpMbKltTracker::setPose(), vpMbGenericTracker::track(), track(), upScale(), and visibleFace().

◆ circles

◆ clippingFlag

◆ cMo

vpHomogeneousMatrix vpMbTracker::cMo
protectedinherited

The current pose.

Definition at line 113 of file vpMbTracker.h.

Referenced by vpMbDepthDenseTracker::computeVisibility(), vpMbDepthNormalTracker::computeVisibility(), vpMbDepthDenseTracker::computeVVS(), vpMbDepthNormalTracker::computeVVS(), vpMbEdgeKltTracker::computeVVS(), vpMbKltMultiTracker::computeVVS(), vpMbEdgeKltMultiTracker::computeVVS(), vpMbEdgeMultiTracker::computeVVS(), vpMbGenericTracker::computeVVS(), vpMbKltTracker::computeVVS(), computeVVS(), vpMbTracker::computeVVSCheckLevenbergMarquardt(), computeVVSFirstPhase(), computeVVSFirstPhaseFactor(), vpMbEdgeMultiTracker::computeVVSFirstPhasePoseEstimation(), computeVVSFirstPhasePoseEstimation(), vpMbDepthDenseTracker::computeVVSInteractionMatrixAndResidu(), vpMbDepthNormalTracker::computeVVSInteractionMatrixAndResidu(), vpMbKltMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbEdgeMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbEdgeKltMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbGenericTracker::computeVVSInteractionMatrixAndResidu(), computeVVSInteractionMatrixAndResidu(), vpMbTracker::computeVVSPoseEstimation(), vpMbDepthNormalTracker::getFeaturesForDisplayDepthNormal(), vpMbTracker::getPolygonFaces(), vpMbKltTracker::getRobustWeights(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbGenericTracker::init(), vpMbEdgeKltTracker::init(), vpMbKltTracker::init(), init(), vpMbEdgeKltMultiTracker::initClick(), vpMbEdgeMultiTracker::initClick(), vpMbKltMultiTracker::initClick(), vpMbGenericTracker::initClick(), vpMbTracker::initClick(), vpMbGenericTracker::initFromPoints(), vpMbTracker::initFromPoints(), vpMbEdgeMultiTracker::initFromPose(), vpMbKltMultiTracker::initFromPose(), vpMbEdgeKltMultiTracker::initFromPose(), vpMbGenericTracker::initFromPose(), vpMbTracker::initFromPose(), vpMbEdgeKltMultiTracker::initMbtTracking(), vpMbEdgeKltTracker::postTracking(), vpMbKltMultiTracker::postTracking(), vpMbKltTracker::postTracking(), vpMbKltMultiTracker::reinit(), vpMbKltTracker::reinit(), reInitLevel(), vpMbDepthDenseTracker::reInitModel(), vpMbDepthNormalTracker::reInitModel(), vpMbKltMultiTracker::reInitModel(), vpMbEdgeMultiTracker::reInitModel(), vpMbEdgeKltTracker::reInitModel(), vpMbGenericTracker::reInitModel(), vpMbKltTracker::reInitModel(), reInitModel(), vpMbDepthDenseTracker::resetTracker(), vpMbDepthNormalTracker::resetTracker(), vpMbEdgeMultiTracker::resetTracker(), vpMbKltMultiTracker::resetTracker(), vpMbGenericTracker::resetTracker(), vpMbKltTracker::resetTracker(), resetTracker(), vpMbTracker::savePose(), vpMbDepthDenseTracker::segmentPointCloud(), vpMbDepthNormalTracker::segmentPointCloud(), vpMbDepthDenseTracker::setPose(), vpMbDepthNormalTracker::setPose(), vpMbKltMultiTracker::setPose(), vpMbEdgeKltTracker::setPose(), vpMbEdgeMultiTracker::setPose(), vpMbEdgeKltMultiTracker::setPose(), vpMbGenericTracker::setPose(), setPose(), vpMbKltTracker::setPose(), vpMbKltMultiTracker::track(), vpMbEdgeMultiTracker::track(), vpMbGenericTracker::track(), track(), vpMbEdgeKltTracker::trackFirstLoop(), trackMovingEdge(), and updateMovingEdge().

◆ computeCovariance

◆ computeProjError

bool vpMbTracker::computeProjError
protectedinherited

◆ covarianceMatrix

vpMatrix vpMbTracker::covarianceMatrix
protectedinherited

◆ cylinders

◆ displayFeatures

◆ distFarClip

◆ distNearClip

◆ faces

vpMbHiddenFaces<vpMbtPolygon> vpMbTracker::faces
protectedinherited

Set of faces describing the object.

Definition at line 143 of file vpMbTracker.h.

Referenced by addCircle(), addCylinder(), vpMbDepthDenseTracker::addFace(), vpMbDepthNormalTracker::addFace(), addLine(), vpMbTracker::addPolygon(), vpMbDepthDenseTracker::computeVisibility(), vpMbDepthNormalTracker::computeVisibility(), vpMbEdgeKltTracker::display(), vpMbKltTracker::display(), display(), vpMbTracker::extractFaces(), vpMbTracker::extractLines(), vpMbGenericTracker::getFaces(), vpMbKltMultiTracker::getFaces(), vpMbEdgeMultiTracker::getFaces(), vpMbEdgeKltMultiTracker::getFaces(), vpMbEdgeKltTracker::getModelForDisplay(), vpMbKltTracker::getModelForDisplay(), vpMbTracker::getPolygonFaces(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbKltTracker::init(), init(), vpMbKltTracker::initCylinder(), vpMbKltTracker::initFaceFromCorners(), vpMbKltTracker::initFaceFromLines(), vpMbTracker::loadCAOModel(), vpMbEdgeKltTracker::loadConfigFile(), vpMbKltTracker::loadConfigFile(), vpMbTracker::loadModel(), vpMbTracker::loadVRMLModel(), vpMbEdgeKltTracker::postTracking(), vpMbEdgeKltMultiTracker::postTracking(), vpMbKltTracker::postTracking(), vpMbKltTracker::reinit(), vpMbEdgeKltTracker::reInitModel(), vpMbKltTracker::reInitModel(), reInitModel(), vpMbDepthDenseTracker::resetTracker(), vpMbDepthNormalTracker::resetTracker(), vpMbKltTracker::resetTracker(), resetTracker(), vpMbTracker::setClipping(), vpMbTracker::setFarClippingDistance(), vpMbKltTracker::setKltMaskBorder(), vpMbTracker::setLod(), vpMbKltTracker::setMaskBorder(), vpMbTracker::setMinLineLengthThresh(), vpMbTracker::setMinPolygonAreaThresh(), vpMbTracker::setNearClippingDistance(), vpMbDepthDenseTracker::setOgreVisibilityTest(), vpMbDepthNormalTracker::setOgreVisibilityTest(), vpMbKltTracker::setOgreVisibilityTest(), setOgreVisibilityTest(), vpMbEdgeKltTracker::setPose(), vpMbKltTracker::setPose(), setUseEdgeTracking(), vpMbGenericTracker::track(), track(), visibleFace(), vpMbDepthDenseTracker::vpMbDepthDenseTracker(), vpMbDepthNormalTracker::vpMbDepthNormalTracker(), vpMbEdgeKltTracker::vpMbEdgeKltTracker(), vpMbEdgeTracker(), and vpMbKltTracker::vpMbKltTracker().

◆ Ipyramid

std::vector<const vpImage<unsigned char> *> vpMbEdgeTracker::Ipyramid
protected

Pyramid of image associated to the current image. This pyramid is computed in the init() and in the track() methods.

Definition at line 301 of file vpMbEdgeTracker.h.

Referenced by vpMbEdgeKltTracker::init(), init(), reInitLevel(), vpMbEdgeKltTracker::setPose(), track(), and ~vpMbEdgeTracker().

◆ isoJoIdentity

bool vpMbTracker::isoJoIdentity
protectedinherited

◆ lines

◆ m_computeInteraction

◆ m_error_edge

◆ m_errorCircles

vpColVector vpMbEdgeTracker::m_errorCircles
protected

◆ m_errorCylinders

vpColVector vpMbEdgeTracker::m_errorCylinders
protected

◆ m_errorLines

vpColVector vpMbEdgeTracker::m_errorLines
protected

◆ m_factor

◆ m_featuresToBeDisplayedEdge

std::vector<std::vector<double> > vpMbEdgeTracker::m_featuresToBeDisplayedEdge
protected

Display features.

Definition at line 333 of file vpMbEdgeTracker.h.

Referenced by displayFeaturesOnImage(), vpMbEdgeKltMultiTracker::postTracking(), and track().

◆ m_I

◆ m_initialMu

◆ m_L_edge

◆ m_lambda

◆ m_mask

◆ m_maxIter

◆ m_optimizationMethod

◆ m_projectionErrorCam

vpCameraParameters vpMbTracker::m_projectionErrorCam
protectedinherited

Camera parameters used for projection error computation.

Definition at line 219 of file vpMbTracker.h.

Referenced by vpMbTracker::computeProjectionErrorImpl(), and vpMbTracker::projectionErrorVisibleFace().

◆ m_projectionErrorCircles

◆ m_projectionErrorCylinders

std::vector<vpMbtDistanceCylinder *> vpMbTracker::m_projectionErrorCylinders
protectedinherited

◆ m_projectionErrorDisplay

bool vpMbTracker::m_projectionErrorDisplay
protectedinherited

Display gradient and model orientation for projection error computation.

Definition at line 213 of file vpMbTracker.h.

Referenced by computeProjectionError(), and vpMbTracker::computeProjectionErrorImpl().

◆ m_projectionErrorDisplayLength

unsigned int vpMbTracker::m_projectionErrorDisplayLength
protectedinherited

Length of the arrows used to show the gradient and model orientation.

Definition at line 215 of file vpMbTracker.h.

Referenced by computeProjectionError(), and vpMbTracker::computeProjectionErrorImpl().

◆ m_projectionErrorDisplayThickness

unsigned int vpMbTracker::m_projectionErrorDisplayThickness
protectedinherited

Thickness of the arrows used to show the gradient and model orientation.

Definition at line 217 of file vpMbTracker.h.

Referenced by computeProjectionError(), and vpMbTracker::computeProjectionErrorImpl().

◆ m_projectionErrorFaces

◆ m_projectionErrorKernelSize

unsigned int vpMbTracker::m_projectionErrorKernelSize
protectedinherited

Kernel size used to compute the gradient orientation.

Definition at line 207 of file vpMbTracker.h.

Referenced by vpMbTracker::loadConfigFile(), vpMbTracker::setProjectionErrorKernelSize(), and vpMbTracker::vpMbTracker().

◆ m_projectionErrorLines

◆ m_projectionErrorMe

vpMe vpMbTracker::m_projectionErrorMe
protectedinherited

◆ m_projectionErrorOgreShowConfigDialog

bool vpMbTracker::m_projectionErrorOgreShowConfigDialog
protectedinherited

Definition at line 203 of file vpMbTracker.h.

Referenced by vpMbTracker::computeProjectionErrorImpl().

◆ m_robust_edge

vpRobust vpMbEdgeTracker::m_robust_edge
protected

Robust.

Definition at line 331 of file vpMbEdgeTracker.h.

◆ m_robustCircles

vpRobust vpMbEdgeTracker::m_robustCircles
protected

◆ m_robustCylinders

vpRobust vpMbEdgeTracker::m_robustCylinders
protected

◆ m_robustLines

vpRobust vpMbEdgeTracker::m_robustLines
protected

◆ m_SobelX

vpMatrix vpMbTracker::m_SobelX
protectedinherited

◆ m_SobelY

vpMatrix vpMbTracker::m_SobelY
protectedinherited

◆ m_stopCriteriaEpsilon

double vpMbTracker::m_stopCriteriaEpsilon
protectedinherited

◆ m_w_edge

◆ m_wCircles

vpColVector vpMbEdgeTracker::m_wCircles
protected

◆ m_wCylinders

vpColVector vpMbEdgeTracker::m_wCylinders
protected

◆ m_weightedError_edge

vpColVector vpMbEdgeTracker::m_weightedError_edge
protected

◆ m_wLines

vpColVector vpMbEdgeTracker::m_wLines
protected

◆ mapOfParameterNames

std::map<std::string, std::string> vpMbTracker::mapOfParameterNames
protectedinherited

Map with [map.first]=parameter_names and [map.second]=type (string, number or boolean)

Definition at line 182 of file vpMbTracker.h.

Referenced by vpMbTracker::parseParameters(), and vpMbTracker::vpMbTracker().

◆ me

vpMe vpMbEdgeTracker::me
protected

◆ minLineLengthThresholdGeneral

double vpMbTracker::minLineLengthThresholdGeneral
protectedinherited

◆ minPolygonAreaThresholdGeneral

double vpMbTracker::minPolygonAreaThresholdGeneral
protectedinherited

◆ modelFileName

std::string vpMbTracker::modelFileName
protectedinherited

The name of the file containing the model (it is used to create a file name.0.pos used to store the compute pose in the initClick method).

Definition at line 120 of file vpMbTracker.h.

Referenced by vpMbTracker::loadModel().

◆ modelInitialised

◆ nbCircles

unsigned int vpMbTracker::nbCircles
protectedinherited

Number of circles in CAO model.

Definition at line 170 of file vpMbTracker.h.

Referenced by vpMbTracker::loadCAOModel(), and vpMbTracker::loadModel().

◆ nbCylinders

unsigned int vpMbTracker::nbCylinders
protectedinherited

Number of cylinders in CAO model.

Definition at line 168 of file vpMbTracker.h.

Referenced by vpMbTracker::loadCAOModel(), and vpMbTracker::loadModel().

◆ nbFeaturesForProjErrorComputation

unsigned int vpMbEdgeTracker::nbFeaturesForProjErrorComputation
protected

Number of features used in the computation of the projection error.

Definition at line 309 of file vpMbEdgeTracker.h.

Referenced by vpMbEdgeMultiTracker::computeProjectionError(), and computeProjectionError().

◆ nbLines

unsigned int vpMbTracker::nbLines
protectedinherited

Number of lines in CAO model.

Definition at line 162 of file vpMbTracker.h.

Referenced by vpMbTracker::loadCAOModel(), and vpMbTracker::loadModel().

◆ nbPoints

unsigned int vpMbTracker::nbPoints
protectedinherited

Number of points in CAO model.

Definition at line 160 of file vpMbTracker.h.

Referenced by vpMbTracker::loadCAOModel(), and vpMbTracker::loadModel().

◆ nbPolygonLines

unsigned int vpMbTracker::nbPolygonLines
protectedinherited

Number of polygon lines in CAO model.

Definition at line 164 of file vpMbTracker.h.

Referenced by vpMbTracker::loadCAOModel(), and vpMbTracker::loadModel().

◆ nbPolygonPoints

unsigned int vpMbTracker::nbPolygonPoints
protectedinherited

Number of polygon points in CAO model.

Definition at line 166 of file vpMbTracker.h.

Referenced by vpMbTracker::loadCAOModel(), and vpMbTracker::loadModel().

◆ nbvisiblepolygone

unsigned int vpMbEdgeTracker::nbvisiblepolygone
protected

Number of polygon (face) currently visible.

Definition at line 290 of file vpMbEdgeTracker.h.

Referenced by vpMbEdgeKltTracker::reInitModel(), reInitModel(), resetTracker(), and visibleFace().

◆ ncircle

unsigned int vpMbEdgeTracker::ncircle
protected

Index of the circle to add, and total number of circles extracted so far.

Definition at line 283 of file vpMbEdgeTracker.h.

Referenced by addCircle(), vpMbEdgeKltTracker::reInitModel(), and reInitModel().

◆ ncylinder

unsigned int vpMbEdgeTracker::ncylinder
protected

Index of the cylinder to add, and total number of cylinders extracted so far.

Definition at line 287 of file vpMbEdgeTracker.h.

Referenced by addCylinder(), vpMbEdgeKltTracker::reInitModel(), reInitModel(), and resetTracker().

◆ nline

unsigned int vpMbEdgeTracker::nline
protected

Index of the polygon to add, and total number of polygon extracted so far.

Definition at line 279 of file vpMbEdgeTracker.h.

Referenced by addLine(), vpMbEdgeKltTracker::reInitModel(), reInitModel(), and resetTracker().

◆ ogreShowConfigDialog

bool vpMbTracker::ogreShowConfigDialog
protectedinherited

◆ oJo

◆ percentageGdPt

double vpMbEdgeTracker::percentageGdPt
protected

Percentage of good points over total number of points below which tracking is supposed to have failed.

Definition at line 294 of file vpMbEdgeTracker.h.

Referenced by getGoodMovingEdgesRatioThreshold(), vpMbEdgeMultiTracker::resetTracker(), resetTracker(), vpMbEdgeMultiTracker::setGoodMovingEdgesRatioThreshold(), testTracking(), and vpMbEdgeMultiTracker::track().

◆ poseSavingFilename

std::string vpMbTracker::poseSavingFilename
protectedinherited

Filename used to save the initial pose computed using the initClick() method. It is also used to read a previous pose in the same method.

Definition at line 126 of file vpMbTracker.h.

Referenced by vpMbTracker::initClick().

◆ projectionError

double vpMbTracker::projectionError
protectedinherited

Error angle between the gradient direction of the model features projected at the resulting pose and their normal.

Definition at line 136 of file vpMbTracker.h.

Referenced by vpMbEdgeMultiTracker::computeProjectionError(), vpMbGenericTracker::computeProjectionError(), computeProjectionError(), vpMbEdgeMultiTracker::track(), vpMbEdgeKltMultiTracker::track(), and track().

◆ scaleLevel

unsigned int vpMbEdgeTracker::scaleLevel
protected

Current scale level used. This attribute must not be modified outside of the downScale() and upScale() methods, as it used to specify to some methods which set of distanceLine use.

Definition at line 306 of file vpMbEdgeTracker.h.

Referenced by computeProjectionError(), computeVVSInteractionMatrixAndResidu(), downScale(), vpMbEdgeKltTracker::getModelForDisplay(), getModelForDisplay(), initMbtTracking(), initMovingEdge(), reInitLevel(), reinitMovingEdge(), testTracking(), trackMovingEdge(), updateMovingEdge(), updateMovingEdgeWeights(), and upScale().

◆ scales

◆ useLodGeneral

bool vpMbTracker::useLodGeneral
protectedinherited

◆ useOgre

◆ useScanLine