Visual Servoing Platform  version 3.6.1 under development (2024-04-16)
vpMbDepthNormalTracker Class Reference

#include <visp3/mbt/vpMbDepthNormalTracker.h>

+ Inheritance diagram for vpMbDepthNormalTracker:

Public Types

enum  vpMbtOptimizationMethod { GAUSS_NEWTON_OPT = 0 , LEVENBERG_MARQUARDT_OPT = 1 }
 

Public Member Functions

 vpMbDepthNormalTracker ()
 
virtual ~vpMbDepthNormalTracker () vp_override
 
virtual void display (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, const vpColor &col, unsigned int thickness=1, bool displayFullModel=false) vp_override
 
virtual void display (const vpImage< vpRGBa > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, const vpColor &col, unsigned int thickness=1, bool displayFullModel=false) vp_override
 
virtual vpMbtFaceDepthNormal::vpFeatureEstimationType getDepthFeatureEstimationMethod () const
 
virtual vpColVector getError () const vp_override
 
virtual std::vector< std::vector< double > > getModelForDisplay (unsigned int width, unsigned int height, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, bool displayFullModel=false) vp_override
 
virtual vpColVector getRobustWeights () const vp_override
 
virtual void init (const vpImage< unsigned char > &I) vp_override
 
virtual void loadConfigFile (const std::string &configFile, bool verbose=true) vp_override
 
void reInitModel (const vpImage< unsigned char > &I, const std::string &cad_name, const vpHomogeneousMatrix &cMo, bool verbose=false)
 
void reInitModel (const pcl::PointCloud< pcl::PointXYZ >::ConstPtr &point_cloud, const std::string &cad_name, const vpHomogeneousMatrix &cMo, bool verbose=false)
 
virtual void resetTracker () vp_override
 
virtual void setCameraParameters (const vpCameraParameters &camera) vp_override
 
virtual void setDepthNormalFaceCentroidMethod (const vpMbtFaceDepthNormal::vpFaceCentroidType &method)
 
virtual void setDepthNormalFeatureEstimationMethod (const vpMbtFaceDepthNormal::vpFeatureEstimationType &method)
 
virtual void setDepthNormalPclPlaneEstimationMethod (int method)
 
virtual void setDepthNormalPclPlaneEstimationRansacMaxIter (int maxIter)
 
virtual void setDepthNormalPclPlaneEstimationRansacThreshold (double thresold)
 
virtual void setDepthNormalSamplingStep (unsigned int stepX, unsigned int stepY)
 
virtual void setOgreVisibilityTest (const bool &v) vp_override
 
virtual void setPose (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cdMo) vp_override
 
virtual void setPose (const vpImage< vpRGBa > &I_color, const vpHomogeneousMatrix &cdMo) vp_override
 
virtual void setPose (const pcl::PointCloud< pcl::PointXYZ >::ConstPtr &point_cloud, const vpHomogeneousMatrix &cdMo)
 
virtual void setScanLineVisibilityTest (const bool &v) vp_override
 
void setUseDepthNormalTracking (const std::string &name, const bool &useDepthNormalTracking)
 
virtual void testTracking () vp_override
 
virtual void track (const vpImage< unsigned char > &) vp_override
 
virtual void track (const vpImage< vpRGBa > &I_color) vp_override
 
virtual void track (const pcl::PointCloud< pcl::PointXYZ >::ConstPtr &point_cloud)
 
virtual void track (const std::vector< vpColVector > &point_cloud, unsigned int width, unsigned int height)
 
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 &cam) 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 (unsigned int index)
 
virtual std::pair< std::vector< vpPolygon >, std::vector< std::vector< vpPoint > > > getPolygonFaces (bool orderPolygons=true, bool useVisibility=true, 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, bool displayHelp=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
 
virtual void initClick (const vpImage< vpRGBa > &I_color, const std::string &initFile, 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, bool verbose=false, const vpHomogeneousMatrix &T=vpHomogeneousMatrix())
 
virtual void setAngleAppear (const double &a)
 
virtual void setAngleDisappear (const double &a)
 
virtual void setClipping (const unsigned int &flags)
 
virtual void setCovarianceComputation (const bool &flag)
 
virtual void setDisplayFeatures (bool displayF)
 
virtual void setEstimatedDoF (const vpColVector &v)
 
virtual void setFarClippingDistance (const double &dist)
 
virtual void setInitialMu (double mu)
 
virtual void setLambda (double gain)
 
virtual void setLod (bool useLod, const std::string &name="")
 
virtual void setMaxIter (unsigned int max)
 
virtual void setMinLineLengthThresh (double minLineLengthThresh, const std::string &name="")
 
virtual void setMinPolygonAreaThresh (double minPolygonAreaThresh, const std::string &name="")
 
virtual void setNearClippingDistance (const double &dist)
 
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 (bool display)
 
virtual void setProjectionErrorDisplayArrowLength (unsigned int length)
 
virtual void setProjectionErrorDisplayArrowThickness (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 (bool showConfigDialog)
 
void setPoseSavingFilename (const std::string &filename)
 

Protected Member Functions

void addFace (vpMbtPolygon &polygon, bool alreadyClose)
 
void computeVisibility (unsigned int width, unsigned int height)
 
void computeVVS ()
 
virtual void computeVVSInit () vp_override
 
virtual void computeVVSInteractionMatrixAndResidu () vp_override
 
virtual std::vector< std::vector< double > > getFeaturesForDisplayDepthNormal ()
 
virtual void initCircle (const vpPoint &p1, const vpPoint &p2, const vpPoint &p3, double radius, int idFace=0, const std::string &name="") vp_override
 
virtual void initCylinder (const vpPoint &p1, const vpPoint &p2, double radius, int idFace=0, const std::string &name="") vp_override
 
virtual void initFaceFromCorners (vpMbtPolygon &polygon) vp_override
 
virtual void initFaceFromLines (vpMbtPolygon &polygon) vp_override
 
void segmentPointCloud (const pcl::PointCloud< pcl::PointXYZ >::ConstPtr &point_cloud)
 
void segmentPointCloud (const std::vector< vpColVector > &point_cloud, unsigned int width, unsigned int height)
 
void segmentPointCloud (const vpMatrix &point_cloud, unsigned int width, unsigned int height)
 
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, 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, int idFace=-1, const std::string &polygonName="", bool useLod=false, double minPolygonAreaThreshold=2500.0, double minLineLengthThreshold=50.0)
 
void addPolygon (const vpPoint &p1, const vpPoint &p2, const vpPoint &p3, double radius, int idFace=-1, const std::string &polygonName="", bool useLod=false, double minPolygonAreaThreshold=2500.0)
 
void addPolygon (const vpPoint &p1, const vpPoint &p2, int idFace=-1, const std::string &polygonName="", bool useLod=false, double minLineLengthThreshold=50)
 
void addPolygon (const std::vector< std::vector< vpPoint > > &listFaces, int idFace=-1, const std::string &polygonName="", bool useLod=false, double minLineLengthThreshold=50)
 
void addProjectionErrorCircle (const vpPoint &P1, const vpPoint &P2, const vpPoint &P3, double r, int idFace=-1, const std::string &name="")
 
void addProjectionErrorCylinder (const vpPoint &P1, const vpPoint &P2, 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, int idFace=-1, const std::string &polygonName="", bool useLod=false, double minPolygonAreaThreshold=2500.0, const double minLineLengthThreshold=50.0)
 
void addProjectionErrorPolygon (const vpPoint &p1, const vpPoint &p2, const vpPoint &p3, double radius, int idFace=-1, const std::string &polygonName="", bool useLod=false, double minPolygonAreaThreshold=2500.0)
 
void addProjectionErrorPolygon (const vpPoint &p1, const vpPoint &p2, int idFace=-1, const std::string &polygonName="", bool useLod=false, double minLineLengthThreshold=50)
 
void addProjectionErrorPolygon (const std::vector< std::vector< vpPoint > > &listFaces, int idFace=-1, const std::string &polygonName="", bool useLod=false, 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 (unsigned int iter, vpColVector &error, const vpColVector &m_error_prev, const vpHomogeneousMatrix &cMoPrev, double &mu, bool &reStartFromLastIncrement, vpColVector *const w=nullptr, const vpColVector *const m_w_prev=nullptr)
 
virtual void computeVVSPoseEstimation (const bool isoJoIdentity, 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=nullptr, vpColVector *const m_w_prev=nullptr)
 
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, double radius, int idFace=0, const std::string &name="")
 
void initProjectionErrorCylinder (const vpPoint &p1, const vpPoint &p2, double radius, 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, bool verbose=false, 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

vpMbtFaceDepthNormal::vpFeatureEstimationType m_depthNormalFeatureEstimationMethod
 
vpMbHiddenFaces< vpMbtPolygonm_depthNormalHiddenFacesDisplay
 
std::vector< vpMbtFaceDepthNormal * > m_depthNormalListOfActiveFaces
 
std::vector< vpColVectorm_depthNormalListOfDesiredFeatures
 
std::vector< vpMbtFaceDepthNormal * > m_depthNormalFaces
 
int m_depthNormalPclPlaneEstimationMethod
 
int m_depthNormalPclPlaneEstimationRansacMaxIter
 
double m_depthNormalPclPlaneEstimationRansacThreshold
 
unsigned int m_depthNormalSamplingStepX
 
unsigned int m_depthNormalSamplingStepY
 
bool m_depthNormalUseRobust
 
vpColVector m_error_depthNormal
 
std::vector< std::vector< double > > m_featuresToBeDisplayedDepthNormal
 
vpMatrix m_L_depthNormal
 
vpRobust m_robust_depthNormal
 
vpColVector m_w_depthNormal
 
vpColVector m_weightedError_depthNormal
 
vpCameraParameters m_cam
 
vpHomogeneousMatrix m_cMo
 
vpMatrix oJo
 
bool m_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
 
bool m_sodb_init_called
 
vpUniRand m_rand
 

Detailed Description

Definition at line 46 of file vpMbDepthNormalTracker.h.

Member Enumeration Documentation

◆ vpMbtOptimizationMethod

Enumerator
GAUSS_NEWTON_OPT 
LEVENBERG_MARQUARDT_OPT 

Definition at line 107 of file vpMbTracker.h.

Constructor & Destructor Documentation

◆ vpMbDepthNormalTracker()

vpMbDepthNormalTracker::vpMbDepthNormalTracker ( )

◆ ~vpMbDepthNormalTracker()

vpMbDepthNormalTracker::~vpMbDepthNormalTracker ( )
virtual

Definition at line 78 of file vpMbDepthNormalTracker.cpp.

References m_depthNormalFaces.

Member Function Documentation

◆ addFace()

◆ addPolygon() [1/4]

◆ addPolygon() [2/4]

◆ addPolygon() [3/4]

◆ addPolygon() [4/4]

◆ addProjectionErrorCircle()

◆ addProjectionErrorCylinder()

◆ addProjectionErrorLine()

◆ addProjectionErrorPolygon() [1/4]

◆ addProjectionErrorPolygon() [2/4]

◆ addProjectionErrorPolygon() [3/4]

◆ addProjectionErrorPolygon() [4/4]

◆ computeCovarianceMatrixVVS()

void vpMbTracker::computeCovarianceMatrixVVS ( const bool  isoJoIdentity,
const vpColVector w_true,
const vpHomogeneousMatrix cMoPrev,
const vpMatrix L_true,
const vpMatrix LVJ_true,
const vpColVector error 
)
protectedvirtualinherited

◆ 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 3497 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 residuals.

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 2888 of file vpMbTracker.cpp.

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

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

◆ computeProjectionErrorImpl()

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

Definition at line 3514 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(), vpMbtDistanceCylinder::isTracked(), vpMbtDistanceLine::isTracked(), vpMbtDistanceCircle::isVisible(), vpMbtDistanceCylinder::isVisible(), vpMbtDistanceLine::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(), vpMbtDistanceCylinder::setCameraParameters(), vpMbtDistanceLine::setCameraParameters(), vpMbHiddenFaces< PolygonType >::setOgreShowConfigDialog(), vpMbTracker::useOgre, and vpMbTracker::useScanLine.

Referenced by vpMbTracker::computeCurrentProjectionError().

◆ computeVisibility()

◆ computeVVS()

◆ computeVVSCheckLevenbergMarquardt()

void vpMbTracker::computeVVSCheckLevenbergMarquardt ( unsigned int  iter,
vpColVector error,
const vpColVector m_error_prev,
const vpHomogeneousMatrix cMoPrev,
double &  mu,
bool &  reStartFromLastIncrement,
vpColVector *const  w = nullptr,
const vpColVector *const  m_w_prev = nullptr 
)
protectedvirtualinherited

◆ computeVVSInit()

◆ computeVVSInteractionMatrixAndResidu()

void vpMbDepthNormalTracker::computeVVSInteractionMatrixAndResidu ( )
protectedvirtual

◆ computeVVSPoseEstimation()

void vpMbTracker::computeVVSPoseEstimation ( const bool  isoJoIdentity,
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 = nullptr,
vpColVector *const  m_w_prev = nullptr 
)
protectedvirtualinherited

◆ computeVVSWeights()

void vpMbTracker::computeVVSWeights ( vpRobust robust,
const vpColVector error,
vpColVector w 
)
protectedvirtualinherited

◆ createCylinderBBox()

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

◆ display() [1/2]

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

Display the 3D model at a given position using the given camera parameters on a grey level image.

Parameters
I: The image.
cMo: Pose used to project the 3D model into the image.
cam: 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.

Definition at line 280 of file vpMbDepthNormalTracker.cpp.

References vpColor::blue, vpDisplay::displayArrow(), vpMbTracker::displayFeatures, vpDisplay::displayLine(), vpMath::equal(), getFeaturesForDisplayDepthNormal(), vpImage< Type >::getHeight(), getModelForDisplay(), vpImage< Type >::getWidth(), and vpColor::red.

◆ display() [2/2]

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

Display the 3D model at a given position using the given camera parameters on a color (RGBa) image.

Parameters
I: The image.
cMo: Pose used to project the 3D model into the image.
cam: 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.

Definition at line 306 of file vpMbDepthNormalTracker.cpp.

References vpColor::blue, vpDisplay::displayArrow(), vpMbTracker::displayFeatures, vpDisplay::displayLine(), vpMath::equal(), getFeaturesForDisplayDepthNormal(), vpImage< Type >::getHeight(), getModelForDisplay(), vpImage< Type >::getWidth(), and vpColor::red.

◆ 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 2467 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 2413 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 2323 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 2553 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 238 of file vpMbTracker.h.

◆ getAngleDisappear()

virtual double vpMbTracker::getAngleDisappear ( ) const
inlinevirtualinherited

Return the angle used to test polygons disappearance.

Definition at line 241 of file vpMbTracker.h.

◆ getCameraParameters()

virtual void vpMbTracker::getCameraParameters ( vpCameraParameters cam) const
inlinevirtualinherited

◆ getClipping()

◆ getCovarianceMatrix()

virtual vpMatrix vpMbTracker::getCovarianceMatrix ( ) const
inlinevirtualinherited

◆ getDepthFeatureEstimationMethod()

virtual vpMbtFaceDepthNormal::vpFeatureEstimationType vpMbDepthNormalTracker::getDepthFeatureEstimationMethod ( ) const
inlinevirtual

Definition at line 58 of file vpMbDepthNormalTracker.h.

◆ getError()

virtual vpColVector vpMbDepthNormalTracker::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.

Definition at line 63 of file vpMbDepthNormalTracker.h.

◆ 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 3013 of file vpMbTracker.cpp.

References vpMbTracker::oJo.

◆ getFaces()

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

Return a reference to the faces structure.

Reimplemented in vpMbGenericTracker.

Definition at line 332 of file vpMbTracker.h.

◆ getFarClippingDistance()

virtual double vpMbTracker::getFarClippingDistance ( ) const
inlinevirtualinherited

Get the far distance for clipping.

Returns
Far clipping value.

Definition at line 339 of file vpMbTracker.h.

◆ getFeaturesForDisplayDepthNormal()

std::vector< std::vector< double > > vpMbDepthNormalTracker::getFeaturesForDisplayDepthNormal ( )
protectedvirtual

◆ 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 2599 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 284 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 291 of file vpMbTracker.h.

◆ 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 298 of file vpMbTracker.h.

◆ getModelForDisplay()

std::vector< std::vector< double > > vpMbDepthNormalTracker::getModelForDisplay ( unsigned int  width,
unsigned int  height,
const vpHomogeneousMatrix cMo,
const vpCameraParameters cam,
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()>, <n_20>, <n_11>, <n_02> where <n_ij> are the second order centered moments of the ellipse normalized by its area (i.e., such that $n_{ij} = \mu_{ij}/a$ where $\mu_{ij}$ are the centered moments and a the area).
Parameters
width: Image width.
height: Image height.
cMo: Pose used to project the 3D model into the image.
cam: The camera parameters.
displayFullModel: If true, the line is displayed even if it is not

Implements vpMbTracker.

Definition at line 361 of file vpMbDepthNormalTracker.cpp.

References vpMbTracker::angleAppears, vpMbTracker::angleDisappears, vpMbHiddenFaces< PolygonType >::computeClippedPolygons(), vpCameraParameters::computeFov(), vpMbHiddenFaces< PolygonType >::computeScanLineRender(), vpMbtFaceDepthNormal::getModelForDisplay(), m_depthNormalFaces, m_depthNormalHiddenFacesDisplay, vpMbHiddenFaces< PolygonType >::setVisible(), and vpMbTracker::useScanLine.

Referenced by display().

◆ getNbPolygon()

virtual unsigned int vpMbTracker::getNbPolygon ( ) const
inlinevirtualinherited

Get the number of polygons (faces) representing the object to track.

Returns
Number of polygons.

Reimplemented in vpMbGenericTracker.

Definition at line 368 of file vpMbTracker.h.

References vpMbHiddenFaces< PolygonType >::size().

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

◆ getNearClippingDistance()

virtual double vpMbTracker::getNearClippingDistance ( ) const
inlinevirtualinherited

Get the near distance for clipping.

Returns
Near clipping value.

Reimplemented in vpMbEdgeKltTracker.

Definition at line 375 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 384 of file vpMbTracker.h.

◆ getPolygon()

virtual vpMbtPolygon* vpMbTracker::getPolygon ( 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 395 of file vpMbTracker.h.

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

◆ getPolygonFaces()

std::pair< std::vector< vpPolygon >, std::vector< std::vector< vpPoint > > > vpMbTracker::getPolygonFaces ( bool  orderPolygons = true,
bool  useVisibility = true,
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 2633 of file vpMbTracker.cpp.

References vpMbTracker::faces, vpMbHiddenFaces< PolygonType >::getPolygon(), vpMbTracker::m_cam, and vpMbTracker::m_cMo.

◆ getPose() [1/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 423 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::getPose().

◆ getPose() [2/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

Reimplemented in vpMbGenericTracker.

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, and tutorial-mb-tracker.cpp.

Definition at line 414 of file vpMbTracker.h.

◆ 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
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, tutorial-mb-generic-tracker-live.cpp, tutorial-mb-generic-tracker-rgbd-realsense-json.cpp, tutorial-mb-generic-tracker-rgbd-realsense.cpp, and tutorial-mb-generic-tracker-rgbd-structure-core.cpp.

Definition at line 310 of file vpMbTracker.h.

◆ getRobustWeights()

virtual vpColVector vpMbDepthNormalTracker::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 w = tracker.getRobustWeights();
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;
unsigned int size() const
Return the number of elements of the 2D array.
Definition: vpArray2D.h:326
Implementation of column vector and the associated operations.
Definition: vpColVector.h:163
double sum() const
See also
getError()

Implements vpMbTracker.

Definition at line 70 of file vpMbDepthNormalTracker.h.

◆ getStopCriteriaEpsilon()

virtual double vpMbTracker::getStopCriteriaEpsilon ( ) const
inlinevirtualinherited

Definition at line 425 of file vpMbTracker.h.

◆ init()

◆ initCircle()

void vpMbDepthNormalTracker::initCircle ( const vpPoint p1,
const vpPoint p2,
const vpPoint p3,
double  radius,
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: A point on the plane containing the circle.
p3: An other point on the plane containing the circle. With the center of the circle p1, p2 and p3 we have 3 points defining the plane that contains the circle.
radius: Radius of the circle.
idFace: Id of the face associated to the circle.
name: Name of the circle.

Implements vpMbTracker.

Definition at line 890 of file vpMbDepthNormalTracker.cpp.

References vpException::fatalError.

◆ initClick() [1/6]

void vpMbTracker::initClick ( const vpImage< unsigned char > &  I,
const std::string &  initFile,
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: Optional display of an image (.ppm, .pgm, .jpg, .jpeg, .png) that should have the same generic name as the init file (ie teabox.ppm or teabox.png). 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.
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, and tutorial-mb-tracker.cpp.

Definition at line 606 of file vpMbTracker.cpp.

Referenced by vpMbDepthDenseTracker::computeVVSWeights(), and vpMbTracker::initClick().

◆ initClick() [2/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.

Definition at line 818 of file vpMbTracker.cpp.

◆ initClick() [3/6]

◆ initClick() [4/6]

◆ initClick() [5/6]

void vpMbTracker::initClick ( const vpImage< vpRGBa > &  I_color,
const std::string &  initFile,
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: Optional display of an image (.ppm, .pgm, .jpg, .jpeg, .png) that should have the same generic name as the init file (ie teabox.ppm or teabox.png). 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 643 of file vpMbTracker.cpp.

References vpMbTracker::initClick().

◆ initClick() [6/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 835 of file vpMbTracker.cpp.

References vpMbTracker::initClick().

◆ initCylinder()

void vpMbDepthNormalTracker::initCylinder ( const vpPoint p1,
const vpPoint p2,
double  radius,
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 associated to the cylinder.
name: Name of the cylinder.

Implements vpMbTracker.

Definition at line 896 of file vpMbDepthNormalTracker.cpp.

References vpException::fatalError.

◆ initFaceFromCorners()

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

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

Implements vpMbTracker.

Definition at line 902 of file vpMbDepthNormalTracker.cpp.

References addFace().

◆ initFaceFromLines()

void vpMbDepthNormalTracker::initFaceFromLines ( vpMbtPolygon polygon)
protectedvirtual

Implements vpMbTracker.

Definition at line 904 of file vpMbDepthNormalTracker.cpp.

References addFace().

◆ 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 996 of file vpMbTracker.cpp.

Referenced by vpMbTracker::initFromPoints().

◆ initFromPoints() [2/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 1070 of file vpMbTracker.cpp.

References vpMbTracker::initFromPoints().

◆ initFromPoints() [3/6]

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

Definition at line 842 of file vpMbTracker.cpp.

◆ initFromPoints() [4/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

◆ initFromPoints() [5/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 1025 of file vpMbTracker.cpp.

References vpMbTracker::initFromPoints().

◆ initFromPoints() [6/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 1084 of file vpMbTracker.cpp.

References vpMbTracker::initFromPoints().

◆ 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 // | Example 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.
Examples
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtKltTracking.cpp, testKeyPoint-2.cpp, and testKeyPoint-4.cpp.

Definition at line 1147 of file vpMbTracker.cpp.

Referenced by vpMbGenericTracker::initFromPose(), vpMbTracker::initFromPose(), vpMbDepthDenseTracker::reInitModel(), reInitModel(), vpMbEdgeTracker::reInitModel(), and vpMbKltTracker::reInitModel().

◆ initFromPose() [2/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 vpMbGenericTracker.

Definition at line 1181 of file vpMbTracker.cpp.

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

◆ initFromPose() [3/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.

Definition at line 1206 of file vpMbTracker.cpp.

References vpMbTracker::initFromPose().

◆ initFromPose() [4/7]

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

◆ initFromPose() [5/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 // | Example 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 1170 of file vpMbTracker.cpp.

References vpMbTracker::initFromPose().

◆ initFromPose() [6/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 1193 of file vpMbTracker.cpp.

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

◆ initFromPose() [7/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 1218 of file vpMbTracker.cpp.

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

◆ initProjectionErrorCircle()

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

Definition at line 3449 of file vpMbTracker.cpp.

References vpMbTracker::addProjectionErrorCircle().

Referenced by vpMbTracker::loadCAOModel().

◆ initProjectionErrorCylinder()

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

◆ initProjectionErrorFaceFromCorners()

void vpMbTracker::initProjectionErrorFaceFromCorners ( vpMbtPolygon polygon)
protectedinherited

◆ initProjectionErrorFaceFromLines()

void vpMbTracker::initProjectionErrorFaceFromLines ( vpMbtPolygon polygon)
protectedinherited

◆ loadCAOModel()

void vpMbTracker::loadCAOModel ( const std::string &  modelFile,
std::vector< std::string > &  vectorOfModelFilename,
int &  startIdFace,
bool  verbose = false,
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 1678 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 vpMbDepthNormalTracker::loadConfigFile ( const std::string &  configFile,
bool  verbose = true 
)
virtual

Load a config file to parameterise the behavior of the tracker.

Virtual method to adapt to each tracker.

Parameters
configFile: An xml config file to parse.
verbose: verbose flag.

Reimplemented from vpMbTracker.

Definition at line 425 of file vpMbDepthNormalTracker.cpp.

References vpMbTracker::angleAppears, vpMbTracker::angleDisappears, vpMbTracker::clippingFlag, vpMath::deg(), vpMbtXmlGenericParser::DEPTH_NORMAL_PARSER, vpPolygon3D::FOV_CLIPPING, vpMbtXmlGenericParser::getAngleAppear(), vpMbtXmlGenericParser::getAngleDisappear(), vpMbtXmlGenericParser::getCameraParameters(), vpMbtXmlGenericParser::getDepthNormalFeatureEstimationMethod(), vpMbtXmlGenericParser::getDepthNormalPclPlaneEstimationMethod(), vpMbtXmlGenericParser::getDepthNormalPclPlaneEstimationRansacMaxIter(), vpMbtXmlGenericParser::getDepthNormalPclPlaneEstimationRansacThreshold(), vpMbtXmlGenericParser::getDepthNormalSamplingStepX(), vpMbtXmlGenericParser::getDepthNormalSamplingStepY(), vpMbtXmlGenericParser::getFarClippingDistance(), vpMbtXmlGenericParser::getFovClipping(), vpMbtXmlGenericParser::getNearClippingDistance(), vpMbtXmlGenericParser::hasFarClippingDistance(), vpMbtXmlGenericParser::hasNearClippingDistance(), vpException::ioError, vpMbTracker::m_cam, m_depthNormalFeatureEstimationMethod, m_depthNormalPclPlaneEstimationMethod, m_depthNormalPclPlaneEstimationRansacMaxIter, m_depthNormalPclPlaneEstimationRansacThreshold, m_depthNormalSamplingStepX, m_depthNormalSamplingStepY, vpMbtXmlGenericParser::parse(), vpMath::rad(), vpMbtXmlGenericParser::setAngleAppear(), vpMbtXmlGenericParser::setAngleDisappear(), vpMbtXmlGenericParser::setCameraParameters(), setCameraParameters(), vpMbTracker::setClipping(), setDepthNormalFeatureEstimationMethod(), vpMbtXmlGenericParser::setDepthNormalFeatureEstimationMethod(), setDepthNormalPclPlaneEstimationMethod(), vpMbtXmlGenericParser::setDepthNormalPclPlaneEstimationMethod(), setDepthNormalPclPlaneEstimationRansacMaxIter(), vpMbtXmlGenericParser::setDepthNormalPclPlaneEstimationRansacMaxIter(), vpMbtXmlGenericParser::setDepthNormalPclPlaneEstimationRansacThreshold(), setDepthNormalPclPlaneEstimationRansacThreshold(), setDepthNormalSamplingStep(), vpMbtXmlGenericParser::setDepthNormalSamplingStepX(), vpMbtXmlGenericParser::setDepthNormalSamplingStepY(), vpMbTracker::setFarClippingDistance(), vpMbTracker::setNearClippingDistance(), vpMbtXmlGenericParser::setVerbose(), and vpException::what().

◆ loadModel()

void vpMbTracker::loadModel ( const std::string &  modelFile,
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.

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.

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, and tutorial-mb-tracker.cpp.

Definition at line 1461 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 vpMbDepthDenseTracker::reInitModel(), reInitModel(), vpMbEdgeTracker::reInitModel(), vpMbKltTracker::reInitModel(), and vpMbEdgeKltTracker::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
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 1513 of file vpMbTracker.cpp.

References vpMbTracker::extractGroup(), vpMbTracker::faces, vpException::fatalError, vpMbTracker::m_sodb_init_called, 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 1576 of file vpMbTracker.cpp.

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

Referenced by vpMbTracker::loadCAOModel().

◆ projectionErrorInitMovingEdge()

◆ projectionErrorResetMovingEdges()

void vpMbTracker::projectionErrorResetMovingEdges ( )
protectedinherited

◆ projectionErrorVisibleFace()

◆ reInitModel() [1/2]

void vpMbDepthNormalTracker::reInitModel ( const pcl::PointCloud< pcl::PointXYZ >::ConstPtr &  point_cloud,
const std::string &  cad_name,
const vpHomogeneousMatrix cMo,
bool  verbose = false 
)

Definition at line 497 of file vpMbDepthNormalTracker.cpp.

References reInitModel().

◆ reInitModel() [2/2]

void vpMbDepthNormalTracker::reInitModel ( const vpImage< unsigned char > &  I,
const std::string &  cad_name,
const vpHomogeneousMatrix cMo,
bool  verbose = false 
)

◆ removeComment()

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

Definition at line 1561 of file vpMbTracker.cpp.

References vpException::ioError.

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

◆ 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 3152 of file vpMbTracker.cpp.

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

Referenced by vpMbEdgeTracker::addCircle(), vpMbEdgeTracker::addCylinder(), vpMbEdgeTracker::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 1230 of file vpMbTracker.cpp.

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

◆ segmentPointCloud() [1/3]

◆ segmentPointCloud() [2/3]

◆ segmentPointCloud() [3/3]

◆ setAngleAppear()

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

Set the angle used to test polygons appearance. If the angle between the normal of the polygon and the line going from the camera to the polygon center has a value lower than this parameter, the polygon is considered as appearing. The polygon will then be tracked.

Parameters
a: new angle in radian.

Reimplemented in vpMbGenericTracker.

Examples
mbtEdgeKltTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.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, and tutorial-mb-tracker-full.cpp.

Definition at line 470 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::setAngleAppear().

◆ setAngleDisappear()

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

Set the angle used to test polygons disappearance. If the angle between the normal of the polygon and the line going from the camera to the polygon center has a value greater than this parameter, the polygon is considered as disappearing. The tracking of the polygon will then be stopped.

Parameters
a: new angle in radian.

Reimplemented in vpMbGenericTracker.

Examples
mbtEdgeKltTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.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, and tutorial-mb-tracker-full.cpp.

Definition at line 481 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::setAngleDisappear().

◆ setCameraParameters()

void vpMbDepthNormalTracker::setCameraParameters ( const vpCameraParameters cam)
virtual

Set the camera parameters.

Parameters
cam: The new camera parameters.

Reimplemented from vpMbTracker.

Definition at line 786 of file vpMbDepthNormalTracker.cpp.

References vpMbTracker::m_cam, and m_depthNormalFaces.

Referenced by loadConfigFile().

◆ setClipping()

void vpMbTracker::setClipping ( const unsigned int &  flags)
virtualinherited

◆ setCovarianceComputation()

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

Set if the covariance matrix has to be computed.

Parameters
flag: True if the covariance has to be computed, false otherwise. If computed its value is available with getCovarianceMatrix()
See also
getCovarianceMatrix()
Examples
mbtEdgeKltTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtGenericTrackingDepthOnly.cpp, and mbtKltTracking.cpp.

Definition at line 500 of file vpMbTracker.h.

◆ setDepthNormalFaceCentroidMethod()

void vpMbDepthNormalTracker::setDepthNormalFaceCentroidMethod ( const vpMbtFaceDepthNormal::vpFaceCentroidType method)
virtual

Definition at line 796 of file vpMbDepthNormalTracker.cpp.

References m_depthNormalFaces.

◆ setDepthNormalFeatureEstimationMethod()

void vpMbDepthNormalTracker::setDepthNormalFeatureEstimationMethod ( const vpMbtFaceDepthNormal::vpFeatureEstimationType method)
virtual

Definition at line 804 of file vpMbDepthNormalTracker.cpp.

References m_depthNormalFaces, and m_depthNormalFeatureEstimationMethod.

Referenced by loadConfigFile().

◆ setDepthNormalPclPlaneEstimationMethod()

void vpMbDepthNormalTracker::setDepthNormalPclPlaneEstimationMethod ( int  method)
virtual

◆ setDepthNormalPclPlaneEstimationRansacMaxIter()

void vpMbDepthNormalTracker::setDepthNormalPclPlaneEstimationRansacMaxIter ( int  maxIter)
virtual

◆ setDepthNormalPclPlaneEstimationRansacThreshold()

void vpMbDepthNormalTracker::setDepthNormalPclPlaneEstimationRansacThreshold ( double  thresold)
virtual

◆ setDepthNormalSamplingStep()

void vpMbDepthNormalTracker::setDepthNormalSamplingStep ( unsigned int  stepX,
unsigned int  stepY 
)
virtual

Definition at line 845 of file vpMbDepthNormalTracker.cpp.

References m_depthNormalSamplingStepX, and m_depthNormalSamplingStepY.

Referenced by loadConfigFile().

◆ setDisplayFeatures()

virtual void vpMbTracker::setDisplayFeatures ( 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.

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, and tutorial-mb-tracker.cpp.

Definition at line 518 of file vpMbTracker.h.

Referenced by 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 correspondence 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;
Examples
tutorial-mb-generic-tracker-full.cpp.

Definition at line 3036 of file vpMbTracker.cpp.

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

◆ setFarClippingDistance()

◆ 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 successful attempts that has to be considered. Value has to be between 0.0 (0%) and 1.0 (100%).

Reimplemented in vpMbGenericTracker.

Definition at line 624 of file vpMbTracker.h.

References vpMbHiddenFaces< PolygonType >::setGoodNbRayCastingAttemptsRatio().

◆ setInitialMu()

virtual void vpMbTracker::setInitialMu ( double  mu)
inlinevirtualinherited

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

Parameters
mu: initial mu.

Definition at line 529 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::loadConfigFileJSON().

◆ setLambda()

virtual void vpMbTracker::setLambda ( 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 536 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::loadConfigFileJSON().

◆ setLod()

void vpMbTracker::setLod ( 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.

Definition at line 2774 of file vpMbTracker.cpp.

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

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

◆ setMask()

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

Reimplemented in vpMbGenericTracker.

Definition at line 564 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::setMask().

◆ setMaxIter()

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

Set the maximum iteration of the virtual visual servoing stage.

Parameters
max: the desired number of iteration

Definition at line 545 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::loadConfigFileJSON().

◆ setMinLineLengthThresh()

void vpMbTracker::setMinLineLengthThresh ( 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.

Definition at line 2792 of file vpMbTracker.cpp.

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

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

◆ setMinPolygonAreaThresh()

void vpMbTracker::setMinPolygonAreaThresh ( 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.

Definition at line 2809 of file vpMbTracker.cpp.

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

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

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

Definition at line 634 of file vpMbTracker.h.

References vpMbHiddenFaces< PolygonType >::setNbRayCastingAttemptsForVisibility().

◆ setNearClippingDistance()

◆ setOgreShowConfigDialog()

virtual void vpMbTracker::setOgreShowConfigDialog ( 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.

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 650 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::setOgreShowConfigDialog().

◆ setOgreVisibilityTest()

void vpMbDepthNormalTracker::setOgreVisibilityTest ( const bool &  v)
virtual

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.

Definition at line 543 of file vpMbDepthNormalTracker.cpp.

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

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

Definition at line 558 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::setOptimizationMethod().

◆ setPose() [1/3]

void vpMbDepthNormalTracker::setPose ( const pcl::PointCloud< pcl::PointXYZ >::ConstPtr &  point_cloud,
const vpHomogeneousMatrix cdMo 
)
virtual

Definition at line 565 of file vpMbDepthNormalTracker.cpp.

References init(), and vpMbTracker::m_cMo.

◆ setPose() [2/3]

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

Warning
This function has to be called after the initialisation of the tracker.
Parameters
I: grayscale image corresponding to the desired pose.
cdMo: Pose to affect.

Implements vpMbTracker.

Definition at line 551 of file vpMbDepthNormalTracker.cpp.

References init(), and vpMbTracker::m_cMo.

◆ setPose() [3/3]

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

Warning
This function has to be called after the initialisation of the tracker.
Parameters
I_color: color image corresponding to the desired pose.
cdMo: Pose to affect.

Implements vpMbTracker.

Definition at line 557 of file vpMbDepthNormalTracker.cpp.

References vpImageConvert::convert(), init(), vpMbTracker::m_cMo, 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 662 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, and vpMbEdgeKltTracker.

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

Definition at line 585 of file vpMbTracker.h.

Referenced by vpMbEdgeKltTracker::setProjectionErrorComputation(), and vpMbGenericTracker::setProjectionErrorComputation().

◆ setProjectionErrorDisplay()

virtual void vpMbTracker::setProjectionErrorDisplay ( bool  display)
inlinevirtualinherited

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

Reimplemented in vpMbGenericTracker.

Examples
mbtGenericTrackingDepthOnly.cpp.

Definition at line 590 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::setProjectionErrorDisplay().

◆ setProjectionErrorDisplayArrowLength()

virtual void vpMbTracker::setProjectionErrorDisplayArrowLength ( 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 595 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::setProjectionErrorDisplayArrowLength().

◆ setProjectionErrorDisplayArrowThickness()

virtual void vpMbTracker::setProjectionErrorDisplayArrowThickness ( 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 603 of file vpMbTracker.h.

Referenced by 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 3867 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

◆ setScanLineVisibilityTest()

void vpMbDepthNormalTracker::setScanLineVisibilityTest ( const bool &  v)
virtual

Reimplemented from vpMbTracker.

Definition at line 574 of file vpMbDepthNormalTracker.cpp.

References m_depthNormalFaces, and vpMbTracker::setScanLineVisibilityTest().

◆ 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 572 of file vpMbTracker.h.

◆ setUseDepthNormalTracking()

void vpMbDepthNormalTracker::setUseDepthNormalTracking ( const std::string &  name,
const bool &  useDepthNormalTracking 
)

◆ testTracking()

void vpMbDepthNormalTracker::testTracking ( )
virtual

Test the quality of the tracking.

Exceptions
vpExceptionif the test fail.

Implements vpMbTracker.

Definition at line 595 of file vpMbDepthNormalTracker.cpp.

◆ track() [1/4]

void vpMbDepthNormalTracker::track ( const pcl::PointCloud< pcl::PointXYZ >::ConstPtr &  point_cloud)
virtual

◆ track() [2/4]

void vpMbDepthNormalTracker::track ( const std::vector< vpColVector > &  point_cloud,
unsigned int  width,
unsigned int  height 
)
virtual

◆ track() [3/4]

void vpMbDepthNormalTracker::track ( const vpImage< unsigned char > &  I)
virtual

Track the object in the given image

Parameters
I: The current image.

Implements vpMbTracker.

Definition at line 860 of file vpMbDepthNormalTracker.cpp.

References vpException::fatalError.

◆ track() [4/4]

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

Track the object in the given image

Parameters
I: The current image.

Implements vpMbTracker.

Definition at line 865 of file vpMbDepthNormalTracker.cpp.

References vpException::fatalError.

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(), vpMbEdgeTracker::loadConfigFile(), and vpMbKltTracker::loadConfigFile().

◆ clippingFlag

◆ computeCovariance

◆ computeProjError

bool vpMbTracker::computeProjError
protectedinherited

Flag used to specify if the gradient error criteria has to be computed or not.

Definition at line 133 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::computeProjectionError(), vpMbEdgeKltTracker::postTracking(), and vpMbEdgeTracker::track().

◆ covarianceMatrix

vpMatrix vpMbTracker::covarianceMatrix
protectedinherited

Covariance matrix.

Definition at line 130 of file vpMbTracker.h.

Referenced by vpMbTracker::computeCovarianceMatrixVVS(), vpMbEdgeTracker::track(), and vpMbGenericTracker::track().

◆ 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 vpMbEdgeTracker::addCircle(), vpMbEdgeTracker::addCylinder(), vpMbDepthDenseTracker::addFace(), addFace(), vpMbEdgeTracker::addLine(), vpMbTracker::addPolygon(), vpMbDepthDenseTracker::computeVisibility(), computeVisibility(), vpMbEdgeKltTracker::display(), vpMbEdgeTracker::display(), vpMbKltTracker::display(), vpMbTracker::extractFaces(), vpMbTracker::extractLines(), vpMbGenericTracker::getFaces(), vpMbEdgeKltTracker::getModelForDisplay(), vpMbKltTracker::getModelForDisplay(), vpMbTracker::getPolygonFaces(), vpMbDepthDenseTracker::init(), init(), vpMbEdgeTracker::init(), vpMbKltTracker::init(), vpMbKltTracker::initCylinder(), vpMbKltTracker::initFaceFromCorners(), vpMbKltTracker::initFaceFromLines(), vpMbTracker::loadCAOModel(), vpMbEdgeKltTracker::loadConfigFile(), vpMbKltTracker::loadConfigFile(), vpMbTracker::loadModel(), vpMbTracker::loadVRMLModel(), vpMbKltTracker::postTracking(), vpMbEdgeKltTracker::postTracking(), vpMbKltTracker::reinit(), vpMbEdgeTracker::reInitModel(), vpMbKltTracker::reInitModel(), vpMbEdgeKltTracker::reInitModel(), vpMbDepthDenseTracker::resetTracker(), resetTracker(), vpMbEdgeTracker::resetTracker(), vpMbKltTracker::resetTracker(), vpMbTracker::setClipping(), vpMbTracker::setFarClippingDistance(), vpMbTracker::setLod(), vpMbTracker::setMinLineLengthThresh(), vpMbTracker::setMinPolygonAreaThresh(), vpMbTracker::setNearClippingDistance(), vpMbDepthDenseTracker::setOgreVisibilityTest(), setOgreVisibilityTest(), vpMbEdgeKltTracker::setPose(), vpMbKltTracker::setPose(), vpMbEdgeTracker::setUseEdgeTracking(), vpMbEdgeTracker::track(), vpMbEdgeTracker::visibleFace(), vpMbDepthDenseTracker::vpMbDepthDenseTracker(), vpMbDepthNormalTracker(), vpMbEdgeKltTracker::vpMbEdgeKltTracker(), vpMbEdgeTracker::vpMbEdgeTracker(), and vpMbKltTracker::vpMbKltTracker().

◆ m_cam

vpCameraParameters vpMbTracker::m_cam
protectedinherited

The camera parameters.

Definition at line 111 of file vpMbTracker.h.

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

◆ m_cMo

vpHomogeneousMatrix vpMbTracker::m_cMo
protectedinherited

The current pose.

Definition at line 113 of file vpMbTracker.h.

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

◆ m_computeInteraction

bool vpMbTracker::m_computeInteraction
protectedinherited

◆ m_depthNormalFaces

◆ m_depthNormalFeatureEstimationMethod

vpMbtFaceDepthNormal::vpFeatureEstimationType vpMbDepthNormalTracker::m_depthNormalFeatureEstimationMethod
protected

Method to estimate the desired features.

Definition at line 124 of file vpMbDepthNormalTracker.h.

Referenced by addFace(), loadConfigFile(), and setDepthNormalFeatureEstimationMethod().

◆ m_depthNormalHiddenFacesDisplay

vpMbHiddenFaces<vpMbtPolygon> vpMbDepthNormalTracker::m_depthNormalHiddenFacesDisplay
protected

Set of faces describing the object used only for display with scan line.

Definition at line 126 of file vpMbDepthNormalTracker.h.

Referenced by addFace(), and getModelForDisplay().

◆ m_depthNormalListOfActiveFaces

std::vector<vpMbtFaceDepthNormal *> vpMbDepthNormalTracker::m_depthNormalListOfActiveFaces
protected

List of current active (visible and with features extracted) faces.

Definition at line 128 of file vpMbDepthNormalTracker.h.

Referenced by computeVVSInteractionMatrixAndResidu(), resetTracker(), and segmentPointCloud().

◆ m_depthNormalListOfDesiredFeatures

std::vector<vpColVector> vpMbDepthNormalTracker::m_depthNormalListOfDesiredFeatures
protected

List of desired features.

Definition at line 130 of file vpMbDepthNormalTracker.h.

Referenced by computeVVS(), computeVVSInit(), computeVVSInteractionMatrixAndResidu(), resetTracker(), and segmentPointCloud().

◆ m_depthNormalPclPlaneEstimationMethod

int vpMbDepthNormalTracker::m_depthNormalPclPlaneEstimationMethod
protected

PCL plane estimation method.

Definition at line 134 of file vpMbDepthNormalTracker.h.

Referenced by addFace(), loadConfigFile(), and setDepthNormalPclPlaneEstimationMethod().

◆ m_depthNormalPclPlaneEstimationRansacMaxIter

int vpMbDepthNormalTracker::m_depthNormalPclPlaneEstimationRansacMaxIter
protected

PCL RANSAC maximum number of iterations.

Definition at line 136 of file vpMbDepthNormalTracker.h.

Referenced by addFace(), loadConfigFile(), and setDepthNormalPclPlaneEstimationRansacMaxIter().

◆ m_depthNormalPclPlaneEstimationRansacThreshold

double vpMbDepthNormalTracker::m_depthNormalPclPlaneEstimationRansacThreshold
protected

PCL RANSAC threshold.

Definition at line 138 of file vpMbDepthNormalTracker.h.

Referenced by addFace(), loadConfigFile(), and setDepthNormalPclPlaneEstimationRansacThreshold().

◆ m_depthNormalSamplingStepX

unsigned int vpMbDepthNormalTracker::m_depthNormalSamplingStepX
protected

Sampling step in x-direction.

Definition at line 140 of file vpMbDepthNormalTracker.h.

Referenced by loadConfigFile(), segmentPointCloud(), and setDepthNormalSamplingStep().

◆ m_depthNormalSamplingStepY

unsigned int vpMbDepthNormalTracker::m_depthNormalSamplingStepY
protected

Sampling step in y-direction.

Definition at line 142 of file vpMbDepthNormalTracker.h.

Referenced by loadConfigFile(), segmentPointCloud(), and setDepthNormalSamplingStep().

◆ m_depthNormalUseRobust

bool vpMbDepthNormalTracker::m_depthNormalUseRobust
protected

If true, use Tukey robust M-Estimator.

Definition at line 144 of file vpMbDepthNormalTracker.h.

Referenced by computeVVS().

◆ m_error_depthNormal

vpColVector vpMbDepthNormalTracker::m_error_depthNormal
protected

(s - s*)

Definition at line 146 of file vpMbDepthNormalTracker.h.

Referenced by computeVVS(), computeVVSInit(), and computeVVSInteractionMatrixAndResidu().

◆ m_featuresToBeDisplayedDepthNormal

std::vector<std::vector<double> > vpMbDepthNormalTracker::m_featuresToBeDisplayedDepthNormal
protected

Display features.

Definition at line 148 of file vpMbDepthNormalTracker.h.

◆ m_I

◆ m_initialMu

double vpMbTracker::m_initialMu
protectedinherited

◆ m_isoJoIdentity

bool vpMbTracker::m_isoJoIdentity
protectedinherited

◆ m_L_depthNormal

vpMatrix vpMbDepthNormalTracker::m_L_depthNormal
protected

Interaction matrix.

Definition at line 150 of file vpMbDepthNormalTracker.h.

Referenced by computeVVS(), computeVVSInit(), and computeVVSInteractionMatrixAndResidu().

◆ 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 vpMbEdgeTracker::computeProjectionError(), vpMbTracker::computeProjectionErrorImpl(), and vpMbGenericTracker::loadConfigFileJSON().

◆ 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 vpMbEdgeTracker::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 vpMbEdgeTracker::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_rand

vpUniRand vpMbTracker::m_rand
protectedinherited

◆ m_robust_depthNormal

vpRobust vpMbDepthNormalTracker::m_robust_depthNormal
protected

Robust.

Definition at line 152 of file vpMbDepthNormalTracker.h.

Referenced by computeVVS(), and computeVVSInit().

◆ m_SobelX

vpMatrix vpMbTracker::m_SobelX
protectedinherited

◆ m_SobelY

vpMatrix vpMbTracker::m_SobelY
protectedinherited

◆ m_sodb_init_called

bool vpMbTracker::m_sodb_init_called
protectedinherited

Flag that indicates that SoDB::init(); was called.

Definition at line 225 of file vpMbTracker.h.

Referenced by vpMbTracker::loadVRMLModel(), and vpMbTracker::~vpMbTracker().

◆ m_stopCriteriaEpsilon

double vpMbTracker::m_stopCriteriaEpsilon
protectedinherited

Epsilon threshold to stop the VVS optimization loop.

Definition at line 191 of file vpMbTracker.h.

Referenced by vpMbDepthDenseTracker::computeVVS(), computeVVS(), vpMbGenericTracker::computeVVS(), and vpMbGenericTracker::resetTracker().

◆ m_w_depthNormal

vpColVector vpMbDepthNormalTracker::m_w_depthNormal
protected

Robust weights.

Definition at line 154 of file vpMbDepthNormalTracker.h.

Referenced by computeVVS(), and computeVVSInit().

◆ m_weightedError_depthNormal

vpColVector vpMbDepthNormalTracker::m_weightedError_depthNormal
protected

Weighted error.

Definition at line 156 of file vpMbDepthNormalTracker.h.

Referenced by computeVVS(), and computeVVSInit().

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

◆ 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

bool vpMbTracker::modelInitialised
protectedinherited

Flag used to ensure that the CAD model is loaded before the initialisation.

Definition at line 123 of file vpMbTracker.h.

Referenced by vpMbTracker::computeCurrentProjectionError(), vpMbDepthDenseTracker::init(), init(), vpMbEdgeTracker::init(), vpMbKltTracker::init(), vpMbTracker::loadModel(), and vpMbGenericTracker::reInitModel().

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

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

◆ ogreShowConfigDialog

bool vpMbTracker::ogreShowConfigDialog
protectedinherited

◆ oJo

◆ 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 vpMbGenericTracker::computeProjectionError(), vpMbEdgeTracker::computeProjectionError(), and vpMbEdgeTracker::track().

◆ useLodGeneral

bool vpMbTracker::useLodGeneral
protectedinherited

◆ useOgre

◆ useScanLine