#include <visp3/mbt/vpMbKltTracker.h>

Inheritance diagram for vpMbKltTracker:

Public Types
enum	vpMbtOptimizationMethod { GAUSS_NEWTON_OPT = 0, LEVENBERG_MARQUARDT_OPT = 1 }

Public Member Functions
	vpMbKltTracker ()

virtual	~vpMbKltTracker ()

Inherited functionalities from vpMbKltTracker
void	addCircle (const vpPoint &P1, const vpPoint &P2, const vpPoint &P3, const double r, const std::string &name="")

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

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

virtual std::list< vpMbtDistanceCircle * > &	getFeaturesCircle ()

virtual std::list< vpMbtDistanceKltCylinder * > &	getFeaturesKltCylinder ()

virtual std::list< vpMbtDistanceKltPoints * > &	getFeaturesKlt ()

std::vector< cv::Point2f >	getKltPoints () const

std::vector< vpImagePoint >	getKltImagePoints () const

std::map< int, vpImagePoint >	getKltImagePointsWithId () const

vpKltOpencv	getKltOpencv () const

unsigned int	getKltMaskBorder () const

int	getKltNbPoints () const

double	getKltThresholdAcceptation () const

virtual vpColVector	getError () const

virtual vpColVector	getRobustWeights () const

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

void	loadConfigFile (const char *configFile)

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

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

void	resetTracker ()

void	setCameraParameters (const vpCameraParameters &cam)

void	setKltMaskBorder (const unsigned int &e)

virtual void	setKltOpencv (const vpKltOpencv &t)

void	setKltThresholdAcceptation (const double th)

virtual void	setOgreVisibilityTest (const bool &v)

virtual void	setScanLineVisibilityTest (const bool &v)

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

virtual void	setProjectionErrorComputation (const bool &flag)

void	setUseKltTracking (const std::string &name, const bool &useKltTracking)

virtual void	testTracking ()

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

Deprecated functions
unsigned int	getMaskBorder () const

int	getNbKltPoints () const

double	getThresholdAcceptation () const

void	setMaskBorder (const unsigned int &e)

void	setThresholdAcceptation (const double th)

Inherited functionalities from vpMbTracker
virtual double	getAngleAppear () const

virtual double	getAngleDisappear () const

virtual void	getCameraParameters (vpCameraParameters &camera) const

virtual unsigned int	getClipping () const

virtual vpMatrix	getCovarianceMatrix () const

virtual double	getInitialMu () const

virtual double	getLambda () const

virtual unsigned int	getMaxIter () const

virtual double	getProjectionError () const

virtual vpColVector	getEstimatedDoF () const

virtual vpMbHiddenFaces< vpMbtPolygon > &	getFaces ()

virtual double	getFarClippingDistance () const

virtual unsigned int	getNbPolygon () const

virtual double	getNearClippingDistance () const

virtual vpMbtOptimizationMethod	getOptimizationMethod () const

virtual vpMbtPolygon *	getPolygon (const unsigned int index)

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

virtual void	getPose (vpHomogeneousMatrix &cMo_) const

virtual vpHomogeneousMatrix	getPose () const

virtual double	getStopCriteriaEpsilon () const

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

virtual void	initClick (const vpImage< unsigned char > &I, 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< unsigned char > &I, 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< unsigned char > &I, const vpHomogeneousMatrix &cMo)

virtual void	initFromPose (const vpImage< unsigned char > &I, const vpPoseVector &cPo)

virtual void	loadModel (const char *modelFile, const bool verbose=false)

virtual void	loadModel (const std::string &modelFile, const bool verbose=false)

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 (const bool displayF)

virtual void	setEstimatedDoF (const vpColVector &v)

virtual void	setFarClippingDistance (const double &dist)

virtual void	setInitialMu (const double mu)

virtual void	setLambda (const double gain)

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

virtual void	setMaxIter (const unsigned int max)

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

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

virtual void	setNearClippingDistance (const double &dist)

virtual void	setOptimizationMethod (const vpMbtOptimizationMethod &opt)

virtual void	setStopCriteriaEpsilon (const double eps)

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

virtual void	setGoodNbRayCastingAttemptsRatio (const double &ratio)

virtual void	setNbRayCastingAttemptsForVisibility (const unsigned int &attempts)

virtual void	setOgreShowConfigDialog (const bool showConfigDialog)

void	setPoseSavingFilename (const std::string &filename)

Protected Member Functions
Protected Member Functions Inherited from vpMbKltTracker
void	computeVVS ()

virtual void	computeVVSInit ()

virtual void	computeVVSInteractionMatrixAndResidu ()

virtual void	init (const vpImage< unsigned char > &I)

virtual void	initFaceFromCorners (vpMbtPolygon &polygon)

virtual void	initFaceFromLines (vpMbtPolygon &polygon)

virtual void	initCircle (const vpPoint &, const vpPoint &, const vpPoint &, const double, const int, const std::string &name="")

virtual void	initCylinder (const vpPoint &, const vpPoint &, const double, const int, const std::string &name="")

void	preTracking (const vpImage< unsigned char > &I)

bool	postTracking (const vpImage< unsigned char > &I, vpColVector &w)

virtual void	reinit (const vpImage< unsigned char > &I)

Protected Member Functions Inherited from vpMbTracker
void	addPolygon (const std::vector< vpPoint > &corners, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minPolygonAreaThreshold=2500.0, const double minLineLengthThreshold=50.0)

void	addPolygon (const vpPoint &p1, const vpPoint &p2, const vpPoint &p3, const double radius, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minPolygonAreaThreshold=2500.0)

void	addPolygon (const vpPoint &p1, const vpPoint &p2, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minLineLengthThreshold=50)

void	addPolygon (const std::vector< std::vector< vpPoint > > &listFaces, const int idFace=-1, const std::string &polygonName="", const bool useLod=false, const double minLineLengthThreshold=50)

void	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

virtual void	computeVVSCheckLevenbergMarquardt (const unsigned int iter, vpColVector &error, const vpColVector &m_error_prev, const vpHomogeneousMatrix &cMoPrev, double &mu, bool &reStartFromLastIncrement, vpColVector const w=NULL, const vpColVector const m_w_prev=NULL)

virtual void	computeVVSPoseEstimation (const bool isoJoIdentity_, const unsigned int iter, vpMatrix &L, vpMatrix &LTL, vpColVector &R, const vpColVector &error, vpColVector &error_prev, vpColVector &LTR, double &mu, vpColVector &v, const vpColVector const w=NULL, vpColVector const m_w_prev=NULL)

virtual void	computeVVSWeights (vpRobust &robust, const vpColVector &error, vpColVector &w)

virtual void	extractGroup (SoVRMLGroup *sceneGraphVRML2, vpHomogeneousMatrix &transform, int &idFace)

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

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

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

vpPoint	getGravityCenter (const std::vector< vpPoint > &_pts) const

virtual void	loadVRMLModel (const std::string &modelFile)

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

void	removeComment (std::ifstream &fileId)

bool	parseBoolean (std::string &input)

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

std::string &	ltrim (std::string &s) const

std::string &	rtrim (std::string &s) const

std::string &	trim (std::string &s) const

Protected Attributes
cv::Mat	cur

vpHomogeneousMatrix	c0Mo

bool	firstInitialisation

unsigned int	maskBorder

double	threshold_outlier

double	percentGood

vpHomogeneousMatrix	ctTc0

vpKltOpencv	tracker

std::list< vpMbtDistanceKltPoints * >	kltPolygons

std::list< vpMbtDistanceKltCylinder * >	kltCylinders

std::list< vpMbtDistanceCircle * >	circles_disp

unsigned int	m_nbInfos

unsigned int	m_nbFaceUsed

vpMatrix	m_L_klt

vpColVector	m_error_klt

vpColVector	m_w_klt

vpColVector	m_weightedError_klt

vpRobust	m_robust_klt

vpCameraParameters	cam

vpHomogeneousMatrix	cMo

vpMatrix	oJo

bool	isoJoIdentity

std::string	modelFileName

bool	modelInitialised

std::string	poseSavingFilename

bool	computeCovariance

vpMatrix	covarianceMatrix

bool	computeProjError

double	projectionError

bool	displayFeatures

vpMbtOptimizationMethod	m_optimizationMethod

vpMbHiddenFaces< vpMbtPolygon >	faces

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

Friends
class	vpMbKltMultiTracker

class	vpMbEdgeKltMultiTracker

Detailed Description

Model based tracker using only KLT.

Warning: This class is only available if OpenCV is installed, and used.

The Tutorial: Markerless model-based tracking is a good starting point to use this class.

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

The following code shows the simplest way to use the tracker. The Tutorial: Markerless model-based tracking is also a good starting point to use this class.

#include <visp/vpCameraParameters.h>
#include <visp/vpDisplayX.h>
#include <visp/vpException.h>
#include <visp/vpHomogeneousMatrix.h>
#include <visp/vpImage.h>
#include <visp/vpImageIo.h>
#include <visp/vpMbKltTracker.h>
int main()
{
#if defined VISP_HAVE_OPENCV
  vpMbKltTracker tracker; // Create a model based tracker via KLT points.
  vpImage<unsigned char> I;
  vpHomogeneousMatrix cMo; // Pose computed using the tracker.
  vpCameraParameters cam;
  // Acquire an image
  vpImageIo::read(I, "cube.pgm");
#if defined VISP_HAVE_X11
  vpDisplayX display;
  display.init(I,100,100,"Mb Klt Tracker");
#endif
#if defined VISP_HAVE_XML2
  tracker.loadConfigFile("cube.xml"); // Load the configuration of the tracker
#endif
  tracker.getCameraParameters(cam);   // Get the camera parameters used by the tracker (from the configuration file).
  tracker.loadModel("cube.cao");      // Load the 3d model in cao format. No 3rd party library is required
  // Initialise manually the pose by clicking on the image points associated to the 3d points contained in the
  // cube.init file.
  tracker.initClick(I, "cube.init");
  while(true){
    // Acquire a new image
    vpDisplay::display(I);
    tracker.track(I);     // Track the object on this image
    tracker.getPose(cMo); // Get the pose
    tracker.display(I, cMo, cam, vpColor::darkRed, 1); // Display the model at the computed pose.
    vpDisplay::flush(I);
  }
#if defined VISP_HAVE_XML2
  // Cleanup memory allocated by xml library used to parse the xml config file
in vpMbKltTracker::loadConfigFile() vpXmlParser::cleanup(); #endif
  return 0;
#endif
}

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

#include <visp/vpCameraParameters.h>
#include <visp/vpHomogeneousMatrix.h>
#include <visp/vpImage.h>
#include <visp/vpImageIo.h>
#include <visp/vpMbKltTracker.h>
int main()
{
#if defined VISP_HAVE_OPENCV
  vpMbKltTracker tracker; // Create a model based tracker via Klt Points.
  vpImage<unsigned char> I;
  vpHomogeneousMatrix cMo; // Pose used in entry (has to be defined), then computed using the tracker.
  //acquire an image
  vpImageIo::read(I, "cube.pgm"); // Example of acquisition
#if defined VISP_HAVE_XML2
  tracker.loadConfigFile("cube.xml"); // Load the configuration of the tracker
#endif
  // load the 3d model, to read .wrl model coin is required, if coin is not installed .cao file can be used.
  tracker.loadModel("cube.cao");
  tracker.initFromPose(I, cMo); // initialize the tracker with the given pose.
  while(true){
    // acquire a new image
    tracker.track(I); // track the object on this image
    tracker.getPose(cMo); // get the pose
  }
#if defined VISP_HAVE_XML2
  // Cleanup memory allocated by xml library used to parse the xml config file in vpMbKltTracker::loadConfigFile()
  vpXmlParser::cleanup();
#endif
  return 0;
#endif
}

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

#include <visp/vpCameraParameters.h>
#include <visp/vpDisplayX.h>
#include <visp/vpHomogeneousMatrix.h>
#include <visp/vpImage.h>
#include <visp/vpImageIo.h>
#include <visp/vpMbKltTracker.h>
int main()
{
#if defined VISP_HAVE_OPENCV
  vpMbKltTracker tracker; // Create a model based tracker via Klt Points.
  vpImage<unsigned char> I;
  vpHomogeneousMatrix cMo; // Pose used to display the model.
  vpCameraParameters cam;
  // Acquire an image
  vpImageIo::read(I, "cube.pgm");
#if defined VISP_HAVE_X11
  vpDisplayX display;
  display.init(I,100,100,"Mb Klt Tracker");
#endif
#if defined VISP_HAVE_XML2
  tracker.loadConfigFile("cube.xml"); // Load the configuration of the tracker
#endif
  tracker.getCameraParameters(cam); // Get the camera parameters used by the tracker (from the configuration file).
  // load the 3d model, to read .wrl model coin is required, if coin is not installed .cao file can be used.
  tracker.loadModel("cube.cao");
  while(true){
    // acquire a new image
    // Get the pose using any method
    vpDisplay::display(I);
    tracker.display(I, cMo, cam, vpColor::darkRed, 1, true); // Display the model at the computed pose.
    vpDisplay::flush(I);
  }
#if defined VISP_HAVE_XML2
  // Cleanup memory allocated by xml library used to parse the xml config file in vpMbKltTracker::loadConfigFile()
  vpXmlParser::cleanup();
#endif
  return 0;
#endif
}

Examples:: mbtKltTracking.cpp, tutorial-mb-klt-tracker.cpp, tutorial-mb-tracker-full.cpp, and tutorial-mb-tracker.cpp.

Definition at line 230 of file vpMbKltTracker.h.

Member Enumeration Documentation

◆ vpMbtOptimizationMethod

enum vpMbTracker::vpMbtOptimizationMethod

inherited

Enumerator
GAUSS_NEWTON_OPT
LEVENBERG_MARQUARDT_OPT

Definition at line 109 of file vpMbTracker.h.

Constructor & Destructor Documentation

◆ vpMbKltTracker()

vpMbKltTracker::vpMbKltTracker ( )

◆ ~vpMbKltTracker()

vpMbKltTracker::~vpMbKltTracker ( )

virtual

Basic destructor.

Definition at line 87 of file vpMbKltTracker.cpp.

References circles_disp, cur, kltCylinders, and kltPolygons.

Member Function Documentation

◆ addCircle()

void vpMbKltTracker::addCircle	(	const vpPoint &	P1,
		const vpPoint &	P2,
		const vpPoint &	P3,
		const double	r,
		const std::string &	name = `""`
	)

Add a circle to the list of circles.

Parameters

P1	: Center of the circle.
P2,P3	: Two points on the plane containing the circle. With the center of the circle we have 3 points defining the plane that contains the circle.
r	: Radius of the circle.
name	: Name of the circle.

Definition at line 1248 of file vpMbKltTracker.cpp.

References vpMbtDistanceCircle::buildFrom(), vpMbTracker::cam, circles_disp, vpMbtDistanceCircle::setCameraParameters(), and vpMbtDistanceCircle::setName().

Referenced by initCircle().

◆ addPolygon() [1/4]

void vpMbTracker::addPolygon	(	const std::vector< vpPoint > &	corners,
		const int	idFace = `-1`,
		const std::string &	polygonName = `""`,
		const bool	useLod = `false`,
		const double	minPolygonAreaThreshold = `2500.0`,
		const double	minLineLengthThreshold = `50.0`
	)

protectedinherited

◆ addPolygon() [2/4]

void vpMbTracker::addPolygon	(	const vpPoint &	p1,
		const vpPoint &	p2,
		const vpPoint &	p3,
		const double	radius,
		const int	idFace = `-1`,
		const std::string &	polygonName = `""`,
		const bool	useLod = `false`,
		const double	minPolygonAreaThreshold = `2500.0`
	)

protectedinherited

◆ addPolygon() [3/4]

void vpMbTracker::addPolygon	(	const vpPoint &	p1,
		const vpPoint &	p2,
		const int	idFace = `-1`,
		const std::string &	polygonName = `""`,
		const bool	useLod = `false`,
		const double	minLineLengthThreshold = `50`
	)

protectedinherited

Definition at line 974 of file vpMbTracker.cpp.

References vpPolygon3D::addPoint(), vpMbHiddenFaces< PolygonType >::addPolygon(), vpMbTracker::clippingFlag, vpMbTracker::distFarClip, vpMbTracker::distNearClip, vpMbTracker::faces, vpPolygon3D::FAR_CLIPPING, vpMbHiddenFaces< PolygonType >::getPolygon(), vpMbTracker::minPolygonAreaThresholdGeneral, vpPolygon3D::NEAR_CLIPPING, vpPolygon3D::NO_CLIPPING, vpMbtPolygon::setIndex(), vpMbtPolygon::setLod(), vpMbtPolygon::setMinLineLengthThresh(), vpMbtPolygon::setMinPolygonAreaThresh(), vpMbtPolygon::setName(), and vpPolygon3D::setNbPoint().

◆ addPolygon() [4/4]

void vpMbTracker::addPolygon	(	const std::vector< std::vector< vpPoint > > &	listFaces,
		const int	idFace = `-1`,
		const std::string &	polygonName = `""`,
		const bool	useLod = `false`,
		const double	minLineLengthThreshold = `50`
	)

protectedinherited

◆ 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

Definition at line 2374 of file vpMbTracker.cpp.

References vpMbTracker::computeCovariance, vpMatrix::computeCovarianceMatrixVVS(), vpMbTracker::covarianceMatrix, and vpMatrix::diag().

Referenced by vpMbDepthDenseTracker::computeVVS(), vpMbDepthNormalTracker::computeVVS(), vpMbGenericTracker::computeVVS(), vpMbKltMultiTracker::computeVVS(), vpMbEdgeKltTracker::computeVVS(), vpMbEdgeMultiTracker::computeVVS(), vpMbEdgeKltMultiTracker::computeVVS(), computeVVS(), vpMbEdgeTracker::computeVVS(), vpMbEdgeKltTracker::testTracking(), and vpMbGenericTracker::track().

◆ computeJTR()

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

protectedinherited

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

Exceptions

vpMatrixException::incorrectMatrixSizeError if 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 2405 of file vpMbTracker.cpp.

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

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

◆ computeVVS()

void vpMbKltTracker::computeVVS ( )

protected

◆ computeVVSCheckLevenbergMarquardt()

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

protectedvirtualinherited

Definition at line 2454 of file vpMbTracker.cpp.

References vpMbTracker::cMo, vpTrackingException::fatalError, vpArray2D< Type >::getRows(), vpMbTracker::LEVENBERG_MARQUARDT_OPT, vpMbTracker::m_optimizationMethod, and vpColVector::sumSquare().

Referenced by vpMbDepthDenseTracker::computeVVS(), vpMbDepthNormalTracker::computeVVS(), vpMbGenericTracker::computeVVS(), vpMbKltMultiTracker::computeVVS(), vpMbEdgeKltTracker::computeVVS(), vpMbEdgeMultiTracker::computeVVS(), vpMbEdgeKltMultiTracker::computeVVS(), computeVVS(), vpMbEdgeTracker::computeVVS(), and vpMbGenericTracker::track().

◆ computeVVSInit()

void vpMbKltTracker::computeVVSInit ( )

protectedvirtual

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeKltTracker, and vpMbKltMultiTracker.

Definition at line 818 of file vpMbKltTracker.cpp.

References vpMbTracker::cam, vpCameraParameters::get_px(), m_error_klt, m_L_klt, m_nbInfos, m_robust_klt, m_w_klt, m_weightedError_klt, vpRobust::resize(), vpArray2D< Type >::resize(), vpColVector::resize(), and vpRobust::setThreshold().

Referenced by vpMbKltMultiTracker::computeVVS(), computeVVS(), vpMbEdgeKltMultiTracker::computeVVSInit(), vpMbKltMultiTracker::getRobustWeights(), and vpMbGenericTracker::track().

◆ computeVVSInteractionMatrixAndResidu()

void vpMbKltTracker::computeVVSInteractionMatrixAndResidu ( )

protectedvirtual

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeKltTracker, and vpMbKltMultiTracker.

Definition at line 833 of file vpMbKltTracker.cpp.

References vpMbtDistanceKltPoints::computeHomography(), vpMbtDistanceKltCylinder::computeInteractionMatrixAndResidu(), vpMbtDistanceKltPoints::computeInteractionMatrixAndResidu(), ctTc0, vpTrackingException::fatalError, vpMbtDistanceKltCylinder::getCurrentNumberPoints(), vpMbtDistanceKltPoints::getCurrentNumberPoints(), vpPolygon3D::getNbPoint(), vpMbtDistanceKltCylinder::hasEnoughPoints(), vpMbtDistanceKltPoints::hasEnoughPoints(), vpMbtDistanceKltCylinder::isTracked(), vpMbtDistanceKltPoints::isTracked(), vpMbtPolygon::isVisible(), kltCylinders, kltPolygons, m_error_klt, m_L_klt, and vpMbtDistanceKltPoints::polygon.

Referenced by computeVVS(), vpMbKltMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbEdgeKltMultiTracker::computeVVSInteractionMatrixAndResidu(), vpMbKltMultiTracker::getRobustWeights(), and vpMbGenericTracker::track().

◆ computeVVSPoseEstimation()

void vpMbTracker::computeVVSPoseEstimation	(	const bool	isoJoIdentity_,
		const unsigned int	iter,
		vpMatrix &	L,
		vpMatrix &	LTL,
		vpColVector &	R,
		const vpColVector &	error,
		vpColVector &	error_prev,
		vpColVector &	LTR,
		double &	mu,
		vpColVector &	v,
		const vpColVector *const	w = `NULL`,
		vpColVector *const	m_w_prev = `NULL`
	)

protectedvirtualinherited

◆ computeVVSWeights()

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

protectedvirtualinherited

Definition at line 2539 of file vpMbTracker.cpp.

References vpArray2D< Type >::getRows(), vpRobust::MEstimator(), and vpRobust::TUKEY.

Referenced by vpMbDepthNormalTracker::computeVVS(), computeVVS(), vpMbKltMultiTracker::computeVVSWeights(), vpMbEdgeKltMultiTracker::computeVVSWeights(), vpMbGenericTracker::getRobustWeights(), vpMbKltMultiTracker::getRobustWeights(), vpMbEdgeKltMultiTracker::setFactorMBT(), vpMbEdgeTracker::setGoodMovingEdgesRatioThreshold(), and vpMbGenericTracker::track().

◆ createCylinderBBox()

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

protectedinherited

Definition at line 2595 of file vpMbTracker.cpp.

References vpException::badValue, vpColVector::clear(), vpColVector::crossProd(), vpColVector::euclideanNorm(), vpPoint::get_oX(), vpPoint::get_oY(), vpPoint::get_oZ(), and vpColVector::normalize().

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

◆ display() [1/2]

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

virtual

Display the 3D model at a given position using the given camera parameters

Parameters

I	: The image.
cMo_	: Pose used to project the 3D model into the image.
camera	: The camera parameters.
col	: The desired color.
thickness	: The thickness of the lines.
displayFullModel	: Boolean to say if all the model has to be displayed, even the faces that are visible.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbEdgeKltMultiTracker, and vpMbKltMultiTracker.

Examples:: mbtKltTracking.cpp, and tutorial-mb-klt-tracker.cpp.

Definition at line 1039 of file vpMbKltTracker.cpp.

Referenced by vpMbGenericTracker::track().

◆ display() [2/2]

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

virtual

Display the 3D model at a given position using the given camera parameters

Parameters

I	: The color image.
cMo_	: Pose used to project the 3D model into the image.
camera	: The camera parameters.
col	: The desired color.
thickness	: The thickness of the lines.
displayFullModel	: Boolean to say if all the model has to be displayed, even the faces that are not visible.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbEdgeKltMultiTracker, and vpMbKltMultiTracker.

Definition at line 1105 of file vpMbKltTracker.cpp.

◆ 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.
polygonName	Name of the polygon.

Definition at line 1998 of file vpMbTracker.cpp.

References vpMbTracker::addPolygon(), vpException::badValue, vpMbTracker::createCylinderBBox(), vpException::dimensionError, vpPoint::get_oX(), vpPoint::get_oY(), vpPoint::get_oZ(), vpMbTracker::getGravityCenter(), vpMbTracker::initCylinder(), 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.
polygonName	Name of the polygon.

Definition at line 1947 of file vpMbTracker.cpp.

References vpMbTracker::addPolygon(), vpMbTracker::faces, vpMbHiddenFaces< PolygonType >::getPolygon(), vpMbTracker::initFaceFromCorners(), 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 1858 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.
polygonName	Name of the polygon.

Definition at line 2077 of file vpMbTracker.cpp.

References vpMbTracker::addPolygon(), vpMbTracker::faces, vpMbHiddenFaces< PolygonType >::getPolygon(), vpMbTracker::initFaceFromCorners(), 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 205 of file vpMbTracker.h.

◆ getAngleDisappear()

virtual double vpMbTracker::getAngleDisappear ( ) const

inlinevirtualinherited

Return the angle used to test polygons disappearance.

Definition at line 208 of file vpMbTracker.h.

◆ getCameraParameters()

virtual void vpMbTracker::getCameraParameters ( vpCameraParameters & camera ) const

inlinevirtualinherited

Get the camera parameters.

Parameters

camera : copy of the camera parameters used by the tracker.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbKltMultiTracker.

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

Definition at line 215 of file vpMbTracker.h.

◆ getClipping()

virtual unsigned int vpMbTracker::getClipping ( ) const

inlinevirtualinherited

Get the clipping used and defined in vpPolygon3D::vpMbtPolygonClippingType.

Returns: Clipping flags.

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

Definition at line 223 of file vpMbTracker.h.

Referenced by vpMbEdgeMultiTracker::getClipping(), vpMbKltMultiTracker::getClipping(), and vpMbEdgeKltMultiTracker::getClipping().

◆ getCovarianceMatrix()

virtual vpMatrix vpMbTracker::getCovarianceMatrix ( ) const

inlinevirtualinherited

Get the covariance matrix. This matrix is only computed if setCovarianceComputation() is turned on.

See also: setCovarianceComputation()

Examples:: mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, mbtGenericTrackingDepth.cpp, mbtKltMultiTracking.cpp, and mbtKltTracking.cpp.

Definition at line 232 of file vpMbTracker.h.

◆ getError()

virtual vpColVector vpMbKltTracker::getError ( ) const

inlinevirtual

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

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

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

See also: getRobustWeights()

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbKltMultiTracker, and vpMbEdgeKltMultiTracker.

Definition at line 345 of file vpMbKltTracker.h.

References m_error_klt.

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

References vpMbTracker::oJo.

◆ getFaces()

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

inlinevirtualinherited

Return a reference to the faces structure.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, vpMbKltMultiTracker, and vpMbGenericTracker.

Definition at line 299 of file vpMbTracker.h.

Referenced by vpMbGenericTracker::getError().

◆ getFarClippingDistance()

virtual double vpMbTracker::getFarClippingDistance ( ) const

inlinevirtualinherited

Get the far distance for clipping.

Returns: Far clipping value.

Definition at line 306 of file vpMbTracker.h.

◆ getFeaturesCircle()

virtual std::list<vpMbtDistanceCircle *>& vpMbKltTracker::getFeaturesCircle ( )

inlinevirtual

Return the address of the circle feature list.

Reimplemented in vpMbKltMultiTracker.

Definition at line 295 of file vpMbKltTracker.h.

References circles_disp.

◆ getFeaturesKlt()

virtual std::list<vpMbtDistanceKltPoints *>& vpMbKltTracker::getFeaturesKlt ( )

inlinevirtual

Return the address of the Klt feature list.

Reimplemented in vpMbKltMultiTracker.

Definition at line 299 of file vpMbKltTracker.h.

References kltPolygons.

◆ getFeaturesKltCylinder()

virtual std::list<vpMbtDistanceKltCylinder *>& vpMbKltTracker::getFeaturesKltCylinder ( )

inlinevirtual

Return the address of the cylinder feature list.

Reimplemented in vpMbKltMultiTracker.

Definition at line 297 of file vpMbKltTracker.h.

References kltCylinders.

◆ 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::dimensionError if 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 2119 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 251 of file vpMbTracker.h.

◆ getKltImagePoints()

std::vector< vpImagePoint > vpMbKltTracker::getKltImagePoints ( ) const

Get the current list of KLT points.

Warning: Contrary to getKltPoints which returns a pointer on CvPoint2D32f. This function convert and copy the openCV KLT points into vpImagePoints.

Returns: the list of KLT points through vpKltOpencv.

Definition at line 332 of file vpMbKltTracker.cpp.

References vpKltOpencv::getFeature(), vpKltOpencv::getNbFeatures(), and tracker.

◆ getKltImagePointsWithId()

std::map< int, vpImagePoint > vpMbKltTracker::getKltImagePointsWithId ( ) const

Get the current list of KLT points and their id.

Warning: Contrary to getKltPoints which returns a pointer on CvPoint2D32f. This function convert and copy the openCV KLT points into vpImagePoints.

Returns: the list of KLT points and their id through vpKltOpencv.

Definition at line 353 of file vpMbKltTracker.cpp.

References vpKltOpencv::getFeature(), vpKltOpencv::getNbFeatures(), and tracker.

◆ getKltMaskBorder()

unsigned int vpMbKltTracker::getKltMaskBorder ( ) const

inline

Get the erosion of the mask used on the Model faces.

Returns: The erosion.

Definition at line 328 of file vpMbKltTracker.h.

References maskBorder.

◆ getKltNbPoints()

int vpMbKltTracker::getKltNbPoints ( ) const

inline

Get the current number of klt points.

Returns: the number of features

Definition at line 335 of file vpMbKltTracker.h.

References vpKltOpencv::getNbFeatures().

◆ getKltOpencv()

vpKltOpencv vpMbKltTracker::getKltOpencv ( ) const

inline

Get the klt tracker at the current state.

Returns: klt tracker.

Definition at line 321 of file vpMbKltTracker.h.

References tracker.

◆ getKltPoints()

std::vector<cv::Point2f> vpMbKltTracker::getKltPoints ( ) const

inline

Get the current list of KLT points.

Returns: the list of KLT points through vpKltOpencv.

Definition at line 307 of file vpMbKltTracker.h.

References vpKltOpencv::getFeatures(), vpMbKltMultiTracker::getKltImagePoints(), vpMbKltMultiTracker::getKltImagePointsWithId(), and vpMbKltMultiTracker::getKltPoints().

◆ getKltThresholdAcceptation()

double vpMbKltTracker::getKltThresholdAcceptation ( ) const

inline

Get the threshold for the acceptation of a point.

Returns: threshold_outlier : Threshold for the weight below which a point is rejected.

Definition at line 343 of file vpMbKltTracker.h.

References threshold_outlier.

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

◆ getMaskBorder()

unsigned int vpMbKltTracker::getMaskBorder ( ) const

inline

Get the erosion of the mask used on the Model faces.

Deprecated:: Use rather getkltMaskBorder()

Returns: The erosion.

Definition at line 442 of file vpMbKltTracker.h.

References maskBorder.

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

◆ getNbKltPoints()

int vpMbKltTracker::getNbKltPoints ( ) const

inline

Get the current number of klt points.

Deprecated:: Use rather getKltNbPoints()

Returns: the number of features

Definition at line 449 of file vpMbKltTracker.h.

References vpKltOpencv::getNbFeatures().

Referenced by vpMbKltMultiTracker::getRobustWeights().

◆ 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 vpMbKltMultiTracker, vpMbEdgeKltMultiTracker, vpMbEdgeMultiTracker, and vpMbGenericTracker.

Definition at line 335 of file vpMbTracker.h.

References vpMbHiddenFaces< PolygonType >::size().

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

◆ getNearClippingDistance()

virtual double vpMbTracker::getNearClippingDistance ( ) const

inlinevirtualinherited

Get the near distance for clipping.

Returns: Near clipping value.

Reimplemented in vpMbEdgeKltTracker.

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

◆ getPolygon()

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

inlinevirtualinherited

Return the polygon (face) "index".

Exceptions

vpException::dimensionError if 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 362 of file vpMbTracker.h.

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

Referenced by vpMbGenericTracker::getError().

◆ getPolygonFaces()

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

virtualinherited

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

Parameters

orderPolygons	: If true, the resulting list is ordered from the nearest polygon faces to the farther.
useVisibility	: If true, only visible faces will be retrieved.
clipPolygon	: If true, the polygons will be clipped according to the clipping flags set in vpMbTracker.

Returns: A pair object containing the list of vpPolygon and the list of face corners.

Reimplemented in vpMbGenericTracker.

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

Definition at line 2153 of file vpMbTracker.cpp.

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

Referenced by vpMbGenericTracker::getError().

◆ getPose() [1/2]

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

inlinevirtualinherited

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

Parameters

cMo_	: the pose

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

Definition at line 381 of file vpMbTracker.h.

◆ getPose() [2/2]

virtual vpHomogeneousMatrix vpMbTracker::getPose ( ) const

inlinevirtualinherited

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

Returns: the current pose

Definition at line 390 of file vpMbTracker.h.

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

◆ getProjectionError()

virtual double vpMbTracker::getProjectionError ( ) const

inlinevirtualinherited

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

Returns: the value for the error.

See also: setProjectionErrorComputation()

Examples:: mbtEdgeKltMultiTracking.cpp, mbtEdgeKltTracking.cpp, mbtEdgeMultiTracking.cpp, mbtEdgeTracking.cpp, mbtGenericTracking.cpp, mbtGenericTracking2.cpp, and mbtGenericTrackingDepth.cpp.

Definition at line 277 of file vpMbTracker.h.

◆ getRobustWeights()

virtual vpColVector vpMbKltTracker::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;

See also: getError()

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbKltMultiTracker, and vpMbEdgeKltMultiTracker.

Definition at line 347 of file vpMbKltTracker.h.

References vpMbTracker::cam, vpMbTracker::cMo, vpMbTracker::loadConfigFile(), m_w_klt, vpMbEdgeKltMultiTracker::reInitModel(), vpMbTracker::resetTracker(), and vpMbTracker::setCameraParameters().

◆ getStopCriteriaEpsilon()

virtual double vpMbTracker::getStopCriteriaEpsilon ( ) const

inlinevirtualinherited

Definition at line 392 of file vpMbTracker.h.

◆ getThresholdAcceptation()

double vpMbKltTracker::getThresholdAcceptation ( ) const

inline

Get the threshold for the acceptation of a point.

Deprecated:: Use rather getKltThresholdAcceptation()

Returns: threshold_outlier : Threshold for the weight below which a point is rejected.

Definition at line 458 of file vpMbKltTracker.h.

References threshold_outlier.

◆ init()

void vpMbKltTracker::init ( const vpImage< unsigned char > & I )

protectedvirtual

Initialise the tracking.

Parameters

I	: Input image.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, vpMbKltMultiTracker, and vpMbEdgeKltMultiTracker.

Definition at line 128 of file vpMbKltTracker.cpp.

References vpMbTracker::angleAppears, vpMbTracker::angleDisappears, vpMbTracker::cam, vpMbTracker::cMo, vpMbTracker::faces, vpException::fatalError, vpImage< Type >::getHeight(), vpImage< Type >::getWidth(), vpMbHiddenFaces< PolygonType >::initOgre(), vpMbHiddenFaces< PolygonType >::isOgreInitialised(), vpMbTracker::modelInitialised, vpMbTracker::ogreShowConfigDialog, reinit(), vpMbHiddenFaces< PolygonType >::setBackgroundSizeOgre(), vpMbHiddenFaces< PolygonType >::setOgreShowConfigDialog(), vpMbHiddenFaces< PolygonType >::setVisible(), vpMbHiddenFaces< PolygonType >::setVisibleOgre(), and vpMbTracker::useOgre.

Referenced by vpMbKltMultiTracker::getRobustWeights(), vpMbEdgeKltTracker::init(), and setPose().

◆ initCircle()

void vpMbKltTracker::initCircle	(	const vpPoint &	p1,
		const vpPoint &	p2,
		const vpPoint &	p3,
		const double	radius,
		const int	,
		const std::string &	name = `""`
	)

protectedvirtual

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

Parameters

p1	: Center of the circle.
p2,p3	: Two points on the plane containing the circle. With the center of the circle we have 3 points defining the plane that contains the circle.
radius	: Radius of the circle.
name	: The optional name of the circle.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, and vpMbEdgeKltMultiTracker.

Definition at line 1234 of file vpMbKltTracker.cpp.

References addCircle().

◆ initClick() [1/2]

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

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 image where the user has to click.
initFile	: File containing the coordinates of at least 4 3D points the user has to click in the image. This file should have .init extension (ie teabox.init).
displayHelp	: Optionnal display of an image that should have the same generic name as the init file (ie teabox.ppm). This image may be used to show where to click. This functionality is only available if visp_io module is used.

Exceptions

vpException::ioError : The file specified in initFile doesn't exist.

Reimplemented in vpMbKltMultiTracker, vpMbEdgeKltMultiTracker, and vpMbEdgeMultiTracker.

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

Definition at line 193 of file vpMbTracker.cpp.

References vpPose::addPoint(), vpException::badValue, vpHomogeneousMatrix::buildFrom(), vpMouseButton::button1, vpMbTracker::cam, vpIoTools::checkFilename(), vpPose::clearPoint(), vpMbTracker::cMo, vpPose::computePose(), vpPose::computeResidual(), vpPixelMeterConversion::convertPoint(), vpPose::DEMENTHON, vpImage< Type >::display, vpMbTracker::display(), vpDisplay::display(), vpDisplay::displayCross(), vpDisplay::displayFrame(), vpDisplay::displayText(), vpHomogeneousMatrix::eye(), vpDisplay::flush(), vpDisplay::getClick(), vpImage< Type >::getWidth(), vpDisplay::getWindowXPosition(), vpDisplay::getWindowYPosition(), vpColor::green, vpMbTracker::init(), vpException::ioError, vpPose::LAGRANGE, vpMbTracker::poseSavingFilename, vpImageIo::read(), vpColor::red, vpMbTracker::savePose(), vpPoint::set_x(), vpPoint::set_y(), vpPoint::setWorldCoordinates(), and vpPose::VIRTUAL_VS.

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

◆ initClick() [2/2]

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 image where the user has to click.
points3D_list	: List of at least 4 3D points with coordinates expressed in meters in the object frame.
displayFile	: Path to the image used to display the help. This image may be used to show where to click. This functionality is only available if visp_io module is used.

Reimplemented in vpMbKltMultiTracker, vpMbEdgeKltMultiTracker, and vpMbEdgeMultiTracker.

Definition at line 445 of file vpMbTracker.cpp.

References vpPose::addPoint(), vpMouseButton::button1, vpMbTracker::cam, vpIoTools::checkFilename(), vpPose::clearPoint(), vpMbTracker::cMo, vpPose::computePose(), vpPose::computeResidual(), vpPixelMeterConversion::convertPoint(), vpPose::DEMENTHON, vpImage< Type >::display, vpMbTracker::display(), vpDisplay::display(), vpDisplay::displayCross(), vpDisplay::displayFrame(), vpDisplay::displayPoint(), vpDisplay::displayText(), vpDisplay::flush(), vpDisplay::getClick(), vpImage< Type >::getWidth(), vpDisplay::getWindowXPosition(), vpDisplay::getWindowYPosition(), vpColor::green, vpMbTracker::init(), vpPose::LAGRANGE, vpImageIo::read(), vpColor::red, and vpPose::VIRTUAL_VS.

◆ initCylinder()

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

protectedvirtual

Add a cylinder to display (not for tracking) 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	: Identifier of the polygon representing the revolution axis of the cylinder.
name	: The optional name of the cylinder.

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, and vpMbEdgeKltMultiTracker.

Definition at line 1204 of file vpMbKltTracker.cpp.

References vpMbtDistanceKltCylinder::buildFrom(), vpMbTracker::cam, vpMbTracker::faces, vpMbtDistanceKltCylinder::hiddenface, kltCylinders, vpMbtDistanceKltCylinder::listIndicesCylinderBBox, vpMbtDistanceKltCylinder::setCameraParameters(), vpMbtDistanceKltCylinder::useScanLine, and vpMbTracker::useScanLine.

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

◆ initFaceFromCorners()

void vpMbKltTracker::initFaceFromCorners ( vpMbtPolygon & polygon )

protectedvirtual

Initialise a new face from the coordinates given in parameter.

Parameters

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

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, and vpMbEdgeKltMultiTracker.

Definition at line 606 of file vpMbKltTracker.cpp.

References vpMbTracker::cam, vpMbTracker::faces, vpMbtDistanceKltPoints::hiddenface, kltPolygons, vpMbtDistanceKltPoints::polygon, vpMbtDistanceKltPoints::setCameraParameters(), vpMbtDistanceKltPoints::useScanLine, and vpMbTracker::useScanLine.

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

◆ initFaceFromLines()

void vpMbKltTracker::initFaceFromLines ( vpMbtPolygon & polygon )

protectedvirtual

Initialise a new face from the coordinates given in parameter.

Parameters

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

Implements vpMbTracker.

Reimplemented in vpMbEdgeKltTracker, and vpMbEdgeKltMultiTracker.

Definition at line 621 of file vpMbKltTracker.cpp.

References vpMbTracker::cam, vpMbTracker::faces, vpMbtDistanceKltPoints::hiddenface, kltPolygons, vpMbtDistanceKltPoints::polygon, vpMbtDistanceKltPoints::setCameraParameters(), vpMbtDistanceKltPoints::useScanLine, and vpMbTracker::useScanLine.

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

◆ initFromPoints() [1/2]

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 image
initFile	: Path to the file containing all the points.

Definition at line 575 of file vpMbTracker.cpp.

References vpPose::addPoint(), vpException::badValue, vpMbTracker::cam, vpMbTracker::cMo, vpPose::computePose(), vpPose::computeResidual(), vpPixelMeterConversion::convertPoint(), vpPose::DEMENTHON, vpMbTracker::init(), vpException::ioError, vpPose::LAGRANGE, vpPoint::set_x(), vpPoint::set_y(), vpPoint::setWorldCoordinates(), and vpPose::VIRTUAL_VS.

Referenced by vpMbGenericTracker::getRobustWeights().

◆ initFromPoints() [2/2]

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 image
points2D_list	: List of image points.
points3D_list	: List of 3D points (object frame).

Definition at line 712 of file vpMbTracker.cpp.

References vpPose::addPoint(), vpMbTracker::cam, vpMbTracker::cMo, vpPose::computePose(), vpPose::computeResidual(), vpPixelMeterConversion::convertPoint(), vpPose::DEMENTHON, vpMbTracker::init(), vpPose::LAGRANGE, vpPose::VIRTUAL_VS, and vpERROR_TRACE.

◆ initFromPose() [1/3]

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
0000    //  \
0000    //  |
0000    //  | Exemple of value for the pose vector where Z = 1 meter
0000    //  |
0000    //  |
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 image
initFile	: Path to the file containing the pose.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbKltMultiTracker, and vpMbEdgeMultiTracker.

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

Definition at line 765 of file vpMbTracker.cpp.

References vpHomogeneousMatrix::buildFrom(), vpMbTracker::cMo, vpMbTracker::init(), and vpException::ioError.

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

◆ initFromPose() [2/3]

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

virtualinherited

Initialise the tracking thanks to the pose.

Parameters

I	: Input image
cMo_	: Pose matrix.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbKltMultiTracker, and vpMbEdgeMultiTracker.

Definition at line 800 of file vpMbTracker.cpp.

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

◆ initFromPose() [3/3]

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

virtualinherited

Initialise the tracking thanks to the pose vector.

Parameters

I	: Input image
cPo	: Pose vector.

Reimplemented in vpMbEdgeKltMultiTracker, vpMbKltMultiTracker, and vpMbEdgeMultiTracker.

Definition at line 812 of file vpMbTracker.cpp.

References vpMbTracker::initFromPose().

◆ loadCAOModel()

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

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.

Read CAO Version (V1, V2, ...)//////////////////////////

Read the header part if present//////////////////////////

Read the point declaration part//////////////////////////

Read the segment declaration part//////////////////////////