#include <vpMbtPolygon.h>

Inheritance diagram for vpMbtPolygon:

Public Types
enum	vpPolygon3DClippingType { NO_CLIPPING = 0 , NEAR_CLIPPING = 1 , FAR_CLIPPING = 2 , LEFT_CLIPPING = 4 , RIGHT_CLIPPING = 8 , UP_CLIPPING = 16 , DOWN_CLIPPING = 32 , FOV_CLIPPING = 60 , ALL_CLIPPING = 63 }

Public Member Functions
	vpMbtPolygon ()
	vpMbtPolygon (const vpMbtPolygon &mbtp)
int	getIndex () const
std::string	getName () const
bool	isAppearing () const
bool	isPolygonOriented ()
virtual bool	isVisible (const vpHomogeneousMatrix &cMo, double alpha, const bool &modulo=false, const vpCameraParameters &cam=vpCameraParameters(), unsigned int width=0, unsigned int height=0)
bool	isVisible () const
vpMbtPolygon &	operator= (const vpMbtPolygon &mbtp)
virtual void	setIndex (int i)
void	setLod (bool use_lod)
void	setMinLineLengthThresh (double min_line_length)
void	setMinPolygonAreaThresh (double min_polygon_area)
void	setName (const std::string &face_name)
void	setIsPolygonOriented (const bool &oriented)
void	addPoint (unsigned int n, const vpPoint &P)
void	changeFrame (const vpHomogeneousMatrix &cMo)
void	computePolygonClipped (const vpCameraParameters &cam=vpCameraParameters())
unsigned int	getClipping () const
double	getFarClippingDistance () const
unsigned int	getNbPoint () const
unsigned int	getNbCornerInsidePrevImage () const
unsigned int	getNbCornerInsideImage (const vpImage< unsigned char > &I, const vpCameraParameters &cam)
double	getNearClippingDistance () const
vpPoint &	getPoint (const unsigned int _index)
std::vector< vpImagePoint >	getRoi (const vpCameraParameters &cam)
std::vector< vpImagePoint >	getRoi (const vpCameraParameters &cam, const vpHomogeneousMatrix &cMo)
void	getRoiClipped (const vpCameraParameters &cam, std::vector< vpImagePoint > &roi)
void	getRoiClipped (const vpCameraParameters &cam, std::vector< vpImagePoint > &roi, const vpHomogeneousMatrix &cMo)
void	getRoiClipped (const vpCameraParameters &cam, std::vector< std::pair< vpImagePoint, unsigned int > > &roi)
void	getRoiClipped (const vpCameraParameters &cam, std::vector< std::pair< vpImagePoint, unsigned int > > &roi, const vpHomogeneousMatrix &cMo)

Public Attributes
int	index
bool	isvisible
bool	isappearing
bool	useLod
double	minLineLengthThresh
double	minPolygonAreaThresh
std::string	name
bool	hasOrientation
unsigned int	nbpt
unsigned int	nbCornersInsidePrev
vpPoint *	p
std::vector< std::pair< vpPoint, unsigned int > >	polyClipped
unsigned int	clippingFlag
double	distNearClip
double	distFarClip

Deprecated functions
VP_DEPRECATED void	getRoiClipped (std::vector< vpPoint > &points)
void	getPolygonClipped (std::vector< std::pair< vpPoint, unsigned int > > &poly)
void	getPolygonClipped (std::vector< vpPoint > &poly)
void	setClipping (const unsigned int &flags)
void	setFarClippingDistance (const double &dist)
virtual void	setNbPoint (unsigned int nb)
void	setNearClippingDistance (const double &dist)
static void	getClippedPolygon (const std::vector< vpPoint > &ptIn, std::vector< vpPoint > &ptOut, const vpHomogeneousMatrix &cMo, const unsigned int &clippingFlags, const vpCameraParameters &cam=vpCameraParameters(), const double &znear=0.001, const double &zfar=100)
static void	getMinMaxRoi (const std::vector< vpImagePoint > &roi, int &i_min, int &i_max, int &j_min, int &j_max)
static bool	roiInsideImage (const vpImage< unsigned char > &I, const std::vector< vpImagePoint > &corners)

Detailed Description

Implementation of a polygon of the model used by the model-based tracker.

Tutorials & Examples

Tutorials
If you are interested in using a MBT tracker in your applications, you may have a look at:

Definition at line 71 of file vpMbtPolygon.h.

Member Enumeration Documentation

◆ vpPolygon3DClippingType

enum vpPolygon3D::vpPolygon3DClippingType

inherited

Enumerator
NO_CLIPPING
NEAR_CLIPPING
FAR_CLIPPING
LEFT_CLIPPING
RIGHT_CLIPPING
UP_CLIPPING
DOWN_CLIPPING
FOV_CLIPPING
ALL_CLIPPING

Definition at line 59 of file vpPolygon3D.h.

Constructor & Destructor Documentation

◆ vpMbtPolygon() [1/2]

BEGIN_VISP_NAMESPACE vpMbtPolygon::vpMbtPolygon ( )

Basic constructor.

Definition at line 53 of file vpMbtPolygon.cpp.

References hasOrientation, index, isappearing, isvisible, minLineLengthThresh, minPolygonAreaThresh, name, and useLod.

Referenced by operator=(), and vpMbtPolygon().

◆ vpMbtPolygon() [2/2]

vpMbtPolygon::vpMbtPolygon ( const vpMbtPolygon & mbtp )

Definition at line 58 of file vpMbtPolygon.cpp.

References hasOrientation, index, isappearing, isvisible, minLineLengthThresh, minPolygonAreaThresh, name, useLod, vpMbtPolygon(), and vpPolygon3D::vpPolygon3D().

Member Function Documentation

◆ addPoint()

void vpPolygon3D::addPoint	(	unsigned int	n,
		const vpPoint &	P )

inherited

Add a corner point to the list of polygon's corners.

Parameters

n	: The index of the corner.
P	: The point to add.

Definition at line 129 of file vpPolygon3D.cpp.

References p.

Referenced by vpMbtFaceDepthDense::addLine(), vpMbtFaceDepthNormal::addLine(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), and getClippedPolygon().

◆ changeFrame()

void vpPolygon3D::changeFrame ( const vpHomogeneousMatrix & cMo )

inherited

Project the 3D corner points into the image thanks to the pose of the camera.

Parameters

cMo	: The pose of the camera.

Definition at line 141 of file vpPolygon3D.cpp.

References nbpt, and p.

Referenced by getClippedPolygon(), getRoi(), getRoiClipped(), getRoiClipped(), vpMbtPolygon::isVisible(), vpMbKltTracker::reinit(), and vpMbKltTracker::setPose().

◆ computePolygonClipped()

void vpPolygon3D::computePolygonClipped ( const vpCameraParameters & cam = vpCameraParameters() )

inherited

Compute the region of interest in the image according to the used clipping.

Warning: If the FOV clipping is used, camera normals have to be precomputed.

Parameters

cam	: camera parameters used to compute the field of view.

Definition at line 156 of file vpPolygon3D.cpp.

References clippingFlag, distFarClip, distNearClip, DOWN_CLIPPING, FAR_CLIPPING, LEFT_CLIPPING, nbpt, NO_CLIPPING, p, polyClipped, vpPoint::projection(), RIGHT_CLIPPING, and UP_CLIPPING.

Referenced by getClippedPolygon(), getRoiClipped(), getRoiClipped(), vpMbtPolygon::isVisible(), vpMbKltTracker::reinit(), and vpMbKltTracker::setPose().

◆ getClippedPolygon()

void vpPolygon3D::getClippedPolygon	(	const std::vector< vpPoint > &	ptIn,
		std::vector< vpPoint > &	ptOut,
		const vpHomogeneousMatrix &	cMo,
		const unsigned int &	clippingFlags,
		const vpCameraParameters &	cam = vpCameraParameters(),
		const double &	znear = 0.001,
		const double &	zfar = 100 )

staticinherited

Static method to compute the clipped points from a set of initial points.

Warning: When using FOV clipping and personnal camera parameters, camera normals have to be computed before (see vpCameraParameters::computeFov())

Parameters

ptIn	: Input points
ptOut	: Output points (result of the clipping).
cMo	: Pose considered for the clipping.
clippingFlags	: Clipping flag, see vpPolygon3D::vpPolygon3DClippingType()).
cam	: Camera parameters (Only used if clipping flags contain FOV clipping).
znear	: Near clipping distance value. Only used if clipping flags contain Near clipping.
zfar	: Far clipping distance value. Only used if clipping flags contain Far clipping.

Definition at line 561 of file vpPolygon3D.cpp.

References addPoint(), changeFrame(), computePolygonClipped(), FAR_CLIPPING, getPolygonClipped(), NEAR_CLIPPING, setClipping(), setFarClippingDistance(), setNbPoint(), setNearClippingDistance(), and vpPolygon3D().

Referenced by vpImageSimulator::setCameraPosition().

◆ getClipping()

unsigned int vpPolygon3D::getClipping ( ) const

inlineinherited

Get the clipping used.

See also: vpPolygon3DClipping

Returns: Clipping flags.

Definition at line 116 of file vpPolygon3D.h.

References clippingFlag.

◆ getFarClippingDistance()

double vpPolygon3D::getFarClippingDistance ( ) const

inlineinherited

Get the far distance for clipping.

Returns: Far clipping value.

Definition at line 123 of file vpPolygon3D.h.

References distFarClip.

◆ getIndex()

int vpMbtPolygon::getIndex ( ) const

inline

Get the index of the face.

Returns: index : the index of the face.

Definition at line 105 of file vpMbtPolygon.h.

References index.

Referenced by vpMbDepthDenseTracker::addFace(), vpMbDepthNormalTracker::addFace(), vpMbEdgeTracker::initFaceFromCorners(), vpMbEdgeTracker::initFaceFromLines(), vpMbTracker::initProjectionErrorFaceFromCorners(), and vpMbTracker::initProjectionErrorFaceFromLines().

◆ getMinMaxRoi()

void vpPolygon3D::getMinMaxRoi	(	const std::vector< vpImagePoint > &	roi,
		int &	i_min,
		int &	i_max,
		int &	j_min,
		int &	j_max )

staticinherited

Definition at line 584 of file vpPolygon3D.cpp.

Referenced by vpMbtDistanceKltCylinder::updateMask(), and vpMbtDistanceKltPoints::updateMask().

◆ getName()

std::string vpMbtPolygon::getName ( ) const

inline

Get the name of the face.

Returns: Name of the face.

Definition at line 112 of file vpMbtPolygon.h.

References name.

Referenced by vpMbDepthDenseTracker::addFace(), vpMbDepthNormalTracker::addFace(), vpMbEdgeTracker::initFaceFromCorners(), vpMbEdgeTracker::initFaceFromLines(), vpMbTracker::initProjectionErrorFaceFromCorners(), vpMbTracker::initProjectionErrorFaceFromLines(), vpMbDepthDenseTracker::setUseDepthDenseTracking(), vpMbDepthNormalTracker::setUseDepthNormalTracking(), and vpMbKltTracker::setUseKltTracking().

◆ getNbCornerInsideImage()

unsigned int vpPolygon3D::getNbCornerInsideImage	(	const vpImage< unsigned char > &	I,
		const vpCameraParameters &	cam )

inherited

Static method to check the number of points of a region defined by the vector of image point that are inside the image.

Parameters

I	: The image used for its size.
cam	: The camera parameters.

Definition at line 526 of file vpPolygon3D.cpp.

References vpMeterPixelConversion::convertPoint(), vpImagePoint::get_i(), vpImagePoint::get_j(), nbCornersInsidePrev, nbpt, and p.

◆ getNbCornerInsidePrevImage()

unsigned int vpPolygon3D::getNbCornerInsidePrevImage ( ) const

inlineinherited

Return the number of corners at the previous computation.

Returns: number of corner of the face at the previous computation

Definition at line 137 of file vpPolygon3D.h.

References nbCornersInsidePrev.

◆ getNbPoint()

unsigned int vpPolygon3D::getNbPoint ( ) const

inlineinherited

Return the number of corners.

Returns: number of corner of the face

Definition at line 130 of file vpPolygon3D.h.

References nbpt.

Referenced by vpMbDepthDenseTracker::addFace(), vpMbDepthNormalTracker::addFace(), vpMbKltTracker::computeVVSInteractionMatrixAndResidu(), vpMbEdgeTracker::initFaceFromCorners(), vpMbEdgeTracker::initFaceFromLines(), vpMbTracker::initProjectionErrorFaceFromCorners(), vpMbTracker::initProjectionErrorFaceFromLines(), vpMbKltTracker::postTracking(), vpMbKltTracker::preTracking(), vpMbKltTracker::reinit(), vpMbKltTracker::setPose(), and vpMbKltTracker::testTracking().

◆ getNearClippingDistance()

double vpPolygon3D::getNearClippingDistance ( ) const

inlineinherited

Get the near distance for clipping.

Returns: Near clipping value.

Definition at line 146 of file vpPolygon3D.h.

References distNearClip.

◆ getPoint()

vpPoint & vpPolygon3D::getPoint ( const unsigned int _index )

inherited

Get a reference to a corner.

Exceptions

vpException::dimensionError if the _index is out of range.

Parameters

_index : the index of the corner

Definition at line 102 of file vpPolygon3D.cpp.

References vpException::dimensionError, nbpt, and p.

◆ getPolygonClipped() [1/2]

void vpPolygon3D::getPolygonClipped ( std::vector< std::pair< vpPoint, unsigned int > > & poly )

inherited

Get the 3D clipped points and their clipping information.

Warning: Suppose that changeFrame() and computePolygonClipped() have already been called.

Parameters

poly	: resulting points plus clipping information.

Definition at line 430 of file vpPolygon3D.cpp.

References polyClipped.

Referenced by getClippedPolygon().

◆ getPolygonClipped() [2/2]

void vpPolygon3D::getPolygonClipped ( std::vector< vpPoint > & poly )

inherited

Get the 3D clipped points.

Warning: Suppose that changeFrame() and computePolygonClipped() have already been called.

Parameters

poly	: resulting points.

Definition at line 440 of file vpPolygon3D.cpp.

References polyClipped.

◆ getRoi() [1/2]

std::vector< vpImagePoint > vpPolygon3D::getRoi ( const vpCameraParameters & cam )

inherited

Get the region of interest in the image.

Warning: Suppose that changeFrame() has already been called.

Parameters

cam	: camera parameters.

Returns: Image point corresponding to the region of interest.

Definition at line 379 of file vpPolygon3D.cpp.

References vpMeterPixelConversion::convertPoint(), nbpt, and p.

Referenced by getRoi().

◆ getRoi() [2/2]

std::vector< vpImagePoint > vpPolygon3D::getRoi	(	const vpCameraParameters &	cam,
		const vpHomogeneousMatrix &	cMo )

inherited

Get the region of interest in the image.

Parameters

cam	: camera parameters.
cMo	: pose.

Returns: Image point corresponding to the region of interest.

Definition at line 399 of file vpPolygon3D.cpp.

References changeFrame(), and getRoi().

◆ getRoiClipped() [1/5]

void vpPolygon3D::getRoiClipped	(	const vpCameraParameters &	cam,
		std::vector< std::pair< vpImagePoint, unsigned int > > &	roi )

inherited

Get the region of interest clipped in the image and the information to know if it's a clipped point.

Warning: Suppose that changeFrame() and computePolygonClipped() have already been called.

Parameters

cam	: camera parameters.
roi	: image point corresponding to the region of interest with clipping information.

Definition at line 493 of file vpPolygon3D.cpp.

References vpMeterPixelConversion::convertPoint(), and polyClipped.

◆ getRoiClipped() [2/5]

void vpPolygon3D::getRoiClipped	(	const vpCameraParameters &	cam,
		std::vector< std::pair< vpImagePoint, unsigned int > > &	roi,
		const vpHomogeneousMatrix &	cMo )

inherited

Get the region of interest clipped in the image and the information to know if it's a clipped point.

Parameters

cam	: camera parameters.
roi	: image point corresponding to the region of interest with clipping information.
cMo	: pose.

Definition at line 511 of file vpPolygon3D.cpp.

References changeFrame(), computePolygonClipped(), and getRoiClipped().

◆ getRoiClipped() [3/5]

void vpPolygon3D::getRoiClipped	(	const vpCameraParameters &	cam,
		std::vector< vpImagePoint > &	roi )

inherited

Get the region of interest clipped in the image.

Warning: Suppose that changeFrame() and computePolygonClipped() have already been called.

Parameters

cam	: camera parameters.
roi	: image point corresponding to the region of interest.

Definition at line 456 of file vpPolygon3D.cpp.

References vpMeterPixelConversion::convertPoint(), and polyClipped.

Referenced by getRoiClipped(), getRoiClipped(), and vpMbtPolygon::isVisible().

◆ getRoiClipped() [4/5]

void vpPolygon3D::getRoiClipped	(	const vpCameraParameters &	cam,
		std::vector< vpImagePoint > &	roi,
		const vpHomogeneousMatrix &	cMo )

inherited

Get the region of interest clipped in the image.

Parameters

cam	: camera parameters.
cMo	: pose.
roi	: image point corresponding to the region of interest.

Definition at line 474 of file vpPolygon3D.cpp.

References changeFrame(), computePolygonClipped(), and getRoiClipped().

◆ getRoiClipped() [5/5]

void vpPolygon3D::getRoiClipped ( std::vector< vpPoint > & points )

inherited

Get the 3D points of the clipped region of interest.

Warning: Suppose that changeFrame() and computePolygonClipped() have already been called.

Parameters

points : resulting points.

Definition at line 414 of file vpPolygon3D.cpp.

References polyClipped.

◆ isAppearing()

bool vpMbtPolygon::isAppearing ( ) const

inline

Definition at line 114 of file vpMbtPolygon.h.

References isappearing.

◆ isPolygonOriented()

bool vpMbtPolygon::isPolygonOriented ( )

inline

Definition at line 115 of file vpMbtPolygon.h.

References hasOrientation.

◆ isVisible() [1/2]

bool vpMbtPolygon::isVisible ( ) const

inline

Definition at line 119 of file vpMbtPolygon.h.

References isvisible.

◆ isVisible() [2/2]

bool vpMbtPolygon::isVisible	(	const vpHomogeneousMatrix &	cMo,
		double	alpha,
		const bool &	modulo = false,
		const vpCameraParameters &	cam = vpCameraParameters(),
		unsigned int	width = 0,
		unsigned int	height = 0 )

virtual

Check if the polygon is visible in the image and if the angle between the normal to the face and the line vector going from the optical center to the cog of the face is below the given threshold. To do that, the polygon is projected into the image thanks to the camera pose.

Parameters

cMo	: The pose of the camera.
alpha	: Maximum angle to detect if the face is visible (in rad).
modulo	: Indicates if the test should also consider faces that are not oriented counter clockwise. If true, the orientation of the face is without importance.
cam	: Camera parameters (intrinsics parameters).
width	: Image width used to consider level of detail.
height	: Image height used to consider level of detail.

Returns: Return true if the polygon is visible.

Definition at line 98 of file vpMbtPolygon.cpp.

References vpPolygon3D::changeFrame(), vpPolygon3D::clippingFlag, vpCameraParameters::computeFov(), vpPolygon3D::computePolygonClipped(), vpColVector::dotProd(), vpPoint::get_X(), vpPoint::get_Y(), vpPoint::get_Z(), vpPolygon::getArea(), vpPolygon3D::getRoiClipped(), hasOrientation, isappearing, isvisible, minLineLengthThresh, minPolygonAreaThresh, vpPolygon3D::nbpt, vpColVector::normalize(), vpPolygon3D::p, vpMath::rad(), vpPoint::set_X(), vpPoint::set_Y(), vpPoint::set_Z(), and useLod.

Referenced by vpMbEdgeKltTracker::computeVVS(), vpMbKltTracker::computeVVSInteractionMatrixAndResidu(), vpMbKltTracker::getFeaturesForDisplayKlt(), vpMbKltTracker::postTracking(), vpMbKltTracker::preTracking(), vpMbKltTracker::reinit(), vpMbKltTracker::setPose(), and vpMbKltTracker::testTracking().

◆ operator=()

vpMbtPolygon & vpMbtPolygon::operator= ( const vpMbtPolygon & mbtp )

Definition at line 66 of file vpMbtPolygon.cpp.

References hasOrientation, index, isappearing, isvisible, minLineLengthThresh, minPolygonAreaThresh, name, vpPolygon3D::operator=(), useLod, and vpMbtPolygon().

◆ roiInsideImage()

bool vpPolygon3D::roiInsideImage	(	const vpImage< unsigned char > &	I,
		const std::vector< vpImagePoint > &	corners )

staticinherited

Static method to check whether the region defined by the vector of image point is contained entirely in the image.

Parameters

I	: The image used for its size.
corners	: The vector of points defining a region

Definition at line 625 of file vpPolygon3D.cpp.

◆ setClipping()

void vpPolygon3D::setClipping ( const unsigned int & flags )

inlineinherited

Specify which clipping to use.

See also: vpPolygon3DClipping

Parameters

flags : New clipping flags.

Definition at line 185 of file vpPolygon3D.h.

References clippingFlag.

Referenced by vpMbEdgeTracker::addLine(), vpMbtFaceDepthDense::addLine(), vpMbtFaceDepthNormal::addLine(), vpMbTracker::addProjectionErrorLine(), getClippedPolygon(), and vpMbEdgeTracker::setClipping().

◆ setFarClippingDistance()

void vpPolygon3D::setFarClippingDistance ( const double & dist )

inlineinherited

Set the far distance for clipping.

Parameters

dist	: Far clipping value.

Definition at line 192 of file vpPolygon3D.h.

References clippingFlag, distFarClip, and FAR_CLIPPING.

Referenced by vpMbEdgeTracker::addLine(), vpMbtFaceDepthDense::addLine(), vpMbtFaceDepthNormal::addLine(), vpMbTracker::addProjectionErrorLine(), getClippedPolygon(), and vpMbEdgeTracker::setFarClippingDistance().

◆ setIndex()

virtual void vpMbtPolygon::setIndex ( int i )

inlinevirtual

Set the index of the face.

Parameters

i	: the new index of the face.

Definition at line 128 of file vpMbtPolygon.h.

References index.

Referenced by vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), and vpMbTracker::addProjectionErrorPolygon().

◆ setIsPolygonOriented()

void vpMbtPolygon::setIsPolygonOriented ( const bool & oriented )

inline

Set if the polygon is oriented or not.

Parameters

oriented : True if the polygon is oriented, false otherwise.

Definition at line 170 of file vpMbtPolygon.h.

Referenced by vpMbTracker::addPolygon(), and vpMbTracker::addProjectionErrorPolygon().

◆ setLod()

void vpMbtPolygon::setLod ( bool use_lod )

Set the flag to consider if the level of detail (LOD) is used or not. When activated, lines and faces of the 3D model are tracked if respectively their projected length and area in the image are significative enough. By significative, we mean:

if the length of the projected line in the image is greater that a threshold set by setMinLineLengthThresh()
if the area of the projected face in the image is greater that a threshold set by setMinPolygonAreaThresh().

Parameters

use_lod : true if level of detail must be used, false otherwise.

The sample code below shows how to introduce this feature:

#include <visp3/io/vpImageIo.h>
#include <visp3/mbt/vpMbEdgeTracker.h>
 
#ifdef ENABLE_VISP_NAMESPACE
using namespace VISP_NAMESPACE_NAME;
#endif
 
int main()
{
  vpImage<unsigned char> I;
 
  // Acquire an image
  vpImageIo::read(I, "my-image.pgm");
 
  std::string object = "my-object";
  vpMbEdgeTracker tracker;
  tracker.loadConfigFile( object+".xml" );
  tracker.loadModel( object+".cao" );
 
  tracker.setLod(true);
  tracker.setMinLineLengthThresh(20.);
  tracker.setMinPolygonAreaThresh(20.*20.);
 
  tracker.initClick(I, object+".init" );
 
  while (true) {
    // tracking loop
  }
}

See also: setMinLineLengthThresh(), setMinPolygonAreaThresh()

Definition at line 274 of file vpMbtPolygon.cpp.

References useLod.

Referenced by vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), and vpMbTracker::addProjectionErrorPolygon().

◆ setMinLineLengthThresh()

void vpMbtPolygon::setMinLineLengthThresh ( double min_line_length )

inline

Set the threshold for the minimum line length to be considered as visible in the LOD (level of detail) case. This threshold is only used when setLoD() is turned on.

Parameters

min_line_length : threshold for the minimum line length in pixel. When a single line that doesn't belong to a face is considered by the tracker, this line is tracked only if its length in pixel is greater than min_line_length.

See also: setLoD()

Definition at line 145 of file vpMbtPolygon.h.

Referenced by vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), and vpMbTracker::addProjectionErrorPolygon().

◆ setMinPolygonAreaThresh()

void vpMbtPolygon::setMinPolygonAreaThresh ( double min_polygon_area )

inline

Set the minimum polygon area to be considered as visible in the LOD (level of detail) case. This threshold is only used when setLoD() is turned on.

Parameters

min_polygon_area : threshold for the minimum polygon area in pixel. When a face is considered by the tracker, this face is tracked only if its area in pixel is greater than min_polygon_area.

See also: setLoD()

Definition at line 156 of file vpMbtPolygon.h.

Referenced by vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), and vpMbTracker::addProjectionErrorPolygon().

◆ setName()

void vpMbtPolygon::setName ( const std::string & face_name )

inline

Set the name of the face.

Parameters

face_name : name of the face.

Definition at line 163 of file vpMbtPolygon.h.

Referenced by vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), and vpMbTracker::addProjectionErrorPolygon().

◆ setNbPoint()

void vpPolygon3D::setNbPoint ( unsigned int nb )

virtualinherited

Set the number of points which are the corners of the polygon.

Parameters

nb	: The number of corners.

Definition at line 115 of file vpPolygon3D.cpp.

References nbpt, and p.

Referenced by vpMbtFaceDepthDense::addLine(), vpMbtFaceDepthNormal::addLine(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), vpMbTracker::addProjectionErrorPolygon(), and getClippedPolygon().

◆ setNearClippingDistance()

void vpPolygon3D::setNearClippingDistance ( const double & dist )

inlineinherited

Set the near distance for clipping.

Parameters

dist	: Near clipping value.

Definition at line 205 of file vpPolygon3D.h.

References clippingFlag, distNearClip, and NEAR_CLIPPING.

Referenced by vpMbEdgeTracker::addLine(), vpMbtFaceDepthDense::addLine(), vpMbtFaceDepthNormal::addLine(), vpMbTracker::addProjectionErrorLine(), getClippedPolygon(), and vpMbEdgeTracker::setNearClippingDistance().

Member Data Documentation

◆ clippingFlag

unsigned int vpPolygon3D::clippingFlag

inherited

Clipping flag.

Definition at line 83 of file vpPolygon3D.h.

Referenced by computePolygonClipped(), getClipping(), vpMbtPolygon::isVisible(), operator=(), setClipping(), setFarClippingDistance(), setNearClippingDistance(), vpPolygon3D(), and vpPolygon3D().

◆ distFarClip

double vpPolygon3D::distFarClip

inherited

Distance for near clipping.

Definition at line 87 of file vpPolygon3D.h.

Referenced by computePolygonClipped(), getFarClippingDistance(), operator=(), setFarClippingDistance(), vpPolygon3D(), and vpPolygon3D().

◆ distNearClip

double vpPolygon3D::distNearClip

inherited

Distance for near clipping.

Definition at line 85 of file vpPolygon3D.h.

Referenced by computePolygonClipped(), getNearClippingDistance(), operator=(), setNearClippingDistance(), vpPolygon3D(), and vpPolygon3D().

◆ hasOrientation

bool vpMbtPolygon::hasOrientation

Boolean that specify if the polygon has an orientation or not (mainly used for cylinders)

Definition at line 94 of file vpMbtPolygon.h.

Referenced by isPolygonOriented(), isVisible(), operator=(), vpMbtPolygon(), and vpMbtPolygon().

◆ index

int vpMbtPolygon::index

Index of the polygon. Cannot be unsigned int because default value is -1.

Definition at line 76 of file vpMbtPolygon.h.

Referenced by getIndex(), operator=(), setIndex(), vpMbtPolygon(), and vpMbtPolygon().

◆ isappearing

bool vpMbtPolygon::isappearing

flag to specify whether the face is appearing or not

Definition at line 80 of file vpMbtPolygon.h.

Referenced by isAppearing(), isVisible(), operator=(), vpMbtPolygon(), and vpMbtPolygon().

◆ isvisible

bool vpMbtPolygon::isvisible

flag to specify whether the face is visible or not

Definition at line 78 of file vpMbtPolygon.h.

Referenced by isVisible(), isVisible(), operator=(), vpMbtPolygon(), and vpMbtPolygon().

◆ minLineLengthThresh

double vpMbtPolygon::minLineLengthThresh

Threshold for minimum line length in pixel to consider if the line is visible or not in LOD case

Definition at line 86 of file vpMbtPolygon.h.

Referenced by isVisible(), operator=(), vpMbtPolygon(), and vpMbtPolygon().

◆ minPolygonAreaThresh

double vpMbtPolygon::minPolygonAreaThresh

Threshold for minimum polygon area in pixel to consider if the polygon is visible or not in LOD case

Definition at line 89 of file vpMbtPolygon.h.

Referenced by isVisible(), operator=(), vpMbtPolygon(), and vpMbtPolygon().

◆ name

std::string vpMbtPolygon::name

Name of the polygon.

Definition at line 91 of file vpMbtPolygon.h.

Referenced by getName(), operator=(), vpMbtPolygon(), and vpMbtPolygon().

◆ nbCornersInsidePrev

unsigned int vpPolygon3D::nbCornersInsidePrev

inherited

Number of corners inside the image during the last call to getNbCornerInsideImage

Definition at line 77 of file vpPolygon3D.h.

Referenced by getNbCornerInsideImage(), getNbCornerInsidePrevImage(), operator=(), vpPolygon3D(), and vpPolygon3D().

◆ nbpt

unsigned int vpPolygon3D::nbpt

inherited

Number of points used to define the polygon.

Definition at line 74 of file vpPolygon3D.h.

Referenced by vpMbDepthDenseTracker::addFace(), vpMbDepthNormalTracker::addFace(), changeFrame(), computePolygonClipped(), getNbCornerInsideImage(), getNbPoint(), getPoint(), getRoi(), vpMbtPolygon::isVisible(), operator=(), setNbPoint(), vpPolygon3D(), and vpPolygon3D().

◆ p

vpPoint* vpPolygon3D::p

inherited

◆ polyClipped

std::vector<std::pair<vpPoint, unsigned int> > vpPolygon3D::polyClipped

inherited

Region of interest clipped.

Definition at line 81 of file vpPolygon3D.h.

Referenced by computePolygonClipped(), getPolygonClipped(), getPolygonClipped(), getRoiClipped(), getRoiClipped(), getRoiClipped(), operator=(), vpPolygon3D(), and vpPolygon3D().

◆ useLod

bool vpMbtPolygon::useLod

Flag to specify if the visibility of the polygon depends also of the current level of detail (LOD)

Definition at line 83 of file vpMbtPolygon.h.

Referenced by isVisible(), operator=(), setLod(), vpMbtPolygon(), and vpMbtPolygon().

Public Types

Public Member Functions

Public Attributes

Deprecated functions

Detailed Description

Tutorials & Examples

Member Enumeration Documentation

◆ vpPolygon3DClippingType

Constructor & Destructor Documentation

◆ vpMbtPolygon() [1/2]

◆ vpMbtPolygon() [2/2]

Member Function Documentation

◆ addPoint()

◆ changeFrame()

◆ computePolygonClipped()

◆ getClippedPolygon()

◆ getClipping()

◆ getFarClippingDistance()

◆ getIndex()

◆ getMinMaxRoi()

◆ getName()

◆ getNbCornerInsideImage()

◆ getNbCornerInsidePrevImage()

◆ getNbPoint()

◆ getNearClippingDistance()

◆ getPoint()

◆ getPolygonClipped() [1/2]

◆ getPolygonClipped() [2/2]

◆ getRoi() [1/2]

◆ getRoi() [2/2]

◆ getRoiClipped() [1/5]

◆ getRoiClipped() [2/5]

◆ getRoiClipped() [3/5]

◆ getRoiClipped() [4/5]

◆ getRoiClipped() [5/5]

◆ isAppearing()

◆ isPolygonOriented()

◆ isVisible() [1/2]

◆ isVisible() [2/2]

◆ operator=()

◆ roiInsideImage()

◆ setClipping()

◆ setFarClippingDistance()

◆ setIndex()

◆ setIsPolygonOriented()

◆ setLod()

◆ setMinLineLengthThresh()

◆ setMinPolygonAreaThresh()

◆ setName()

◆ setNbPoint()

◆ setNearClippingDistance()

Member Data Documentation

◆ clippingFlag

◆ distFarClip

◆ distNearClip

◆ hasOrientation

◆ index

◆ isappearing

◆ isvisible

◆ minLineLengthThresh

◆ minPolygonAreaThresh

◆ name

◆ nbCornersInsidePrev

◆ nbpt

◆ p

◆ polyClipped

◆ useLod