Visual Servoing Platform  version 3.5.0 under development (2022-02-15)
vpMbHiddenFaces< PolygonType > Class Template Reference

#include <visp3/mbt/vpMbHiddenFaces.h>

Public Member Functions

 vpMbHiddenFaces ()
 
virtual ~vpMbHiddenFaces ()
 
 vpMbHiddenFaces (const vpMbHiddenFaces &copy)
 
vpMbHiddenFacesoperator= (vpMbHiddenFaces other)
 
void addPolygon (PolygonType *p)
 
bool computeVisibility (const vpHomogeneousMatrix &cMo, const double &angleAppears, const double &angleDisappears, bool &changed, bool useOgre, bool not_used, unsigned int width, unsigned int height, const vpCameraParameters &cam, const vpTranslationVector &cameraPos, unsigned int index)
 
void computeClippedPolygons (const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam)
 
void computeScanLineRender (const vpCameraParameters &cam, const unsigned int &w, const unsigned int &h)
 
void computeScanLineQuery (const vpPoint &a, const vpPoint &b, std::vector< std::pair< vpPoint, vpPoint > > &lines, const bool &displayResults=false)
 
vpMbScanLine & getMbScanLineRenderer ()
 
void displayOgre (const vpHomogeneousMatrix &cMo)
 
std::vector< PolygonType * > & getPolygon ()
 
void initOgre (const vpCameraParameters &cam=vpCameraParameters())
 
unsigned int getNbVisiblePolygon () const
 
unsigned int getNbRayCastingAttemptsForVisibility ()
 
vpAROgregetOgreContext ()
 
double getGoodNbRayCastingAttemptsRatio ()
 
bool isAppearing (unsigned int i)
 
bool isOgreInitialised ()
 
bool isVisible (unsigned int i)
 
bool isVisibleOgre (const vpTranslationVector &cameraPos, const unsigned int &index)
 
PolygonType * operator[] (unsigned int i)
 
const PolygonType * operator[] (unsigned int i) const
 
void reset ()
 
void setBackgroundSizeOgre (const unsigned int &h, const unsigned int &w)
 
void setNbRayCastingAttemptsForVisibility (const unsigned int &attempts)
 
void setGoodNbRayCastingAttemptsRatio (const double &ratio)
 
void setOgreShowConfigDialog (bool showConfigDialog)
 
unsigned int setVisible (unsigned int width, unsigned int height, const vpCameraParameters &cam, const vpHomogeneousMatrix &cMo, const double &angle, bool &changed)
 
unsigned int setVisible (unsigned int width, unsigned int height, const vpCameraParameters &cam, const vpHomogeneousMatrix &cMo, const double &angleAppears, const double &angleDisappears, bool &changed)
 
unsigned int setVisible (const vpHomogeneousMatrix &cMo, const double &angleAppears, const double &angleDisappears, bool &changed)
 
unsigned int setVisibleOgre (unsigned int width, unsigned int height, const vpCameraParameters &cam, const vpHomogeneousMatrix &cMo, const double &angleAppears, const double &angleDisappears, bool &changed)
 
unsigned int setVisibleOgre (const vpHomogeneousMatrix &cMo, const double &angleAppears, const double &angleDisappears, bool &changed)
 
unsigned int size () const
 

Friends

void swap (vpMbHiddenFaces &first, vpMbHiddenFaces &second)
 

Detailed Description

template<class PolygonType = vpMbtPolygon>
class vpMbHiddenFaces< PolygonType >

Implementation of the polygons management for the model-based trackers.

Definition at line 58 of file vpMbHiddenFaces.h.

Constructor & Destructor Documentation

◆ vpMbHiddenFaces() [1/2]

template<class PolygonType >
vpMbHiddenFaces< PolygonType >::vpMbHiddenFaces ( )

Basic constructor.

Definition at line 284 of file vpMbHiddenFaces.h.

◆ ~vpMbHiddenFaces()

template<class PolygonType >
vpMbHiddenFaces< PolygonType >::~vpMbHiddenFaces ( )
virtual

Basic destructor.

Definition at line 299 of file vpMbHiddenFaces.h.

◆ vpMbHiddenFaces() [2/2]

template<class PolygonType = vpMbtPolygon>
vpMbHiddenFaces ( const vpMbHiddenFaces< PolygonType > &  copy)

Definition at line 331 of file vpMbHiddenFaces.h.

Member Function Documentation

◆ addPolygon()

template<class PolygonType>
void vpMbHiddenFaces< PolygonType >::addPolygon ( PolygonType *  p)

Add a polygon to the list of polygons.

Parameters
p: The polygon to add.

Definition at line 378 of file vpMbHiddenFaces.h.

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

◆ computeClippedPolygons()

template<class PolygonType >
void vpMbHiddenFaces< PolygonType >::computeClippedPolygons ( const vpHomogeneousMatrix cMo,
const vpCameraParameters cam 
)

◆ computeScanLineQuery()

template<class PolygonType >
void vpMbHiddenFaces< PolygonType >::computeScanLineQuery ( const vpPoint a,
const vpPoint b,
std::vector< std::pair< vpPoint, vpPoint > > &  lines,
const bool &  displayResults = false 
)

Compute Scanline visibility results for a line.

Warning
computeScanLineRender() function has to be called before
Parameters
a: First point of the line.
b: Second point of the line.
lines: Result of the scanline visibility. List of the visible parts of the line.
displayResults: True if the results have to be displayed. False otherwise

Definition at line 501 of file vpMbHiddenFaces.h.

Referenced by vpMbtFaceDepthDense::computeROI(), vpMbtFaceDepthNormal::computeROI(), vpMbtDistanceKltPoints::getModelForDisplay(), vpMbtDistanceLine::getModelForDisplay(), vpMbtDistanceLine::initMovingEdge(), and vpMbtDistanceLine::updateMovingEdge().

◆ computeScanLineRender()

template<class PolygonType >
void vpMbHiddenFaces< PolygonType >::computeScanLineRender ( const vpCameraParameters cam,
const unsigned int &  w,
const unsigned int &  h 
)

◆ computeVisibility()

template<class PolygonType >
bool vpMbHiddenFaces< PolygonType >::computeVisibility ( const vpHomogeneousMatrix cMo,
const double &  angleAppears,
const double &  angleDisappears,
bool &  changed,
bool  useOgre,
bool  not_used,
unsigned int  width,
unsigned int  height,
const vpCameraParameters cam,
const vpTranslationVector cameraPos,
unsigned int  index 
)

Compute the visibility of a given face index.

Parameters
cMo: The pose of the camera
angleAppears: Angle used to test the appearance of a face
angleDisappears: Angle used to test the disappearance of a face
changed: True if a face appeared, disappeared or too many points have been lost. False otherwise
useOgre: True if a Ogre is used to test the visibility, False otherwise.
not_used: Unused parameter.
width,heightImage size.
cam: Camera parameters.
cameraPos: Position of the camera. Used only when Ogre is used as 3rd party.
index: Index of the face to consider.
Returns
Return true if the face is visible.

Definition at line 569 of file vpMbHiddenFaces.h.

Referenced by vpMbHiddenFaces< vpMbtPolygon >::computeScanLineQuery().

◆ displayOgre()

template<class PolygonType >
void vpMbHiddenFaces< PolygonType >::displayOgre ( const vpHomogeneousMatrix cMo)

◆ getGoodNbRayCastingAttemptsRatio()

template<class PolygonType = vpMbtPolygon>
double vpMbHiddenFaces< PolygonType >::getGoodNbRayCastingAttemptsRatio ( )
inline

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

See also
getNbRayCastingAttemptsForVisibility()
Returns
Ratio of succesful attempts that has to be considered. Value will be between 0.0 (0%) and 1.0 (100%).

Definition at line 166 of file vpMbHiddenFaces.h.

◆ getMbScanLineRenderer()

◆ getNbRayCastingAttemptsForVisibility()

template<class PolygonType = vpMbtPolygon>
unsigned int vpMbHiddenFaces< PolygonType >::getNbRayCastingAttemptsForVisibility ( )
inline

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

See also
getGoodNbRayCastingAttemptsRatio()
Returns
Number of rays sent.

Definition at line 148 of file vpMbHiddenFaces.h.

◆ getNbVisiblePolygon()

template<class PolygonType = vpMbtPolygon>
unsigned int vpMbHiddenFaces< PolygonType >::getNbVisiblePolygon ( ) const
inline

get the number of visible polygons.

Returns
number of visible polygons.

Definition at line 136 of file vpMbHiddenFaces.h.

◆ getOgreContext()

◆ getPolygon()

template<class PolygonType = vpMbtPolygon>
std::vector<PolygonType *>& vpMbHiddenFaces< PolygonType >::getPolygon ( )
inline

◆ initOgre()

template<class PolygonType >
void vpMbHiddenFaces< PolygonType >::initOgre ( const vpCameraParameters cam = vpCameraParameters())

◆ isAppearing()

template<class PolygonType = vpMbtPolygon>
bool vpMbHiddenFaces< PolygonType >::isAppearing ( unsigned int  i)
inline

◆ isOgreInitialised()

template<class PolygonType = vpMbtPolygon>
bool vpMbHiddenFaces< PolygonType >::isOgreInitialised ( )
inline

Tell whether if Ogre Context is initialised or not.

Returns
True if it does, false otherwise.

Definition at line 177 of file vpMbHiddenFaces.h.

Referenced by vpMbTracker::computeProjectionErrorImpl(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbKltTracker::init(), vpMbEdgeTracker::init(), and vpMbGenericTracker::track().

◆ isVisible()

template<class PolygonType = vpMbtPolygon>
bool vpMbHiddenFaces< PolygonType >::isVisible ( unsigned int  i)
inline

Check if the polygon at position i in the list is visible.

Parameters
i: TPosition in the list.
Returns
Return true if the polygon is visible.

Definition at line 187 of file vpMbHiddenFaces.h.

Referenced by vpMbHiddenFaces< vpMbtPolygon >::computeVisibility(), vpMbtFaceDepthDense::computeVisibilityDisplay(), vpMbtFaceDepthNormal::computeVisibilityDisplay(), vpMbHiddenFaces< vpMbtPolygon >::displayOgre(), vpMbEdgeTracker::initMovingEdge(), and vpMbTracker::projectionErrorInitMovingEdge().

◆ isVisibleOgre()

template<class PolygonType >
bool vpMbHiddenFaces< PolygonType >::isVisibleOgre ( const vpTranslationVector cameraPos,
const unsigned int &  index 
)

Test the visibility of a polygon through Ogre3D via RayCasting.

Parameters
cameraPos: Position of the camera in the 3D world.
index: Index of the polygon.
Returns
Return true if the polygon is visible, False otherwise.

Definition at line 810 of file vpMbHiddenFaces.h.

Referenced by vpMbHiddenFaces< vpMbtPolygon >::computeVisibility(), and vpMbHiddenFaces< vpMbtPolygon >::isVisible().

◆ operator=()

template<class PolygonType >
vpMbHiddenFaces< PolygonType > & vpMbHiddenFaces< PolygonType >::operator= ( vpMbHiddenFaces< PolygonType >  other)

Copy assignment operator.

Definition at line 366 of file vpMbHiddenFaces.h.

◆ operator[]() [1/2]

template<class PolygonType = vpMbtPolygon>
PolygonType* vpMbHiddenFaces< PolygonType >::operator[] ( unsigned int  i)
inline

operator[] as modifier.

Definition at line 194 of file vpMbHiddenFaces.h.

◆ operator[]() [2/2]

template<class PolygonType = vpMbtPolygon>
const PolygonType* vpMbHiddenFaces< PolygonType >::operator[] ( unsigned int  i) const
inline

operator[] as reader.

Definition at line 196 of file vpMbHiddenFaces.h.

◆ reset()

◆ setBackgroundSizeOgre()

template<class PolygonType = vpMbtPolygon>
void vpMbHiddenFaces< PolygonType >::setBackgroundSizeOgre ( const unsigned int &  h,
const unsigned int &  w 
)
inline

Set the background size (by default it is 640x480). The background size has to match with the size of the image that you are using for the traking.

Warning
This function has to be called before initOgre().
Parameters
h: Height of the background
w: Width of the background

Definition at line 211 of file vpMbHiddenFaces.h.

Referenced by vpMbTracker::computeProjectionErrorImpl(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbKltTracker::init(), vpMbEdgeTracker::init(), and vpMbGenericTracker::track().

◆ setGoodNbRayCastingAttemptsRatio()

template<class PolygonType = vpMbtPolygon>
void vpMbHiddenFaces< PolygonType >::setGoodNbRayCastingAttemptsRatio ( const double &  ratio)
inline

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

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

Definition at line 236 of file vpMbHiddenFaces.h.

Referenced by vpMbTracker::setGoodNbRayCastingAttemptsRatio().

◆ setNbRayCastingAttemptsForVisibility()

template<class PolygonType = vpMbtPolygon>
void vpMbHiddenFaces< PolygonType >::setNbRayCastingAttemptsForVisibility ( const unsigned int &  attempts)
inline

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

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

Definition at line 225 of file vpMbHiddenFaces.h.

Referenced by vpMbTracker::setNbRayCastingAttemptsForVisibility().

◆ setOgreShowConfigDialog()

template<class PolygonType = vpMbtPolygon>
void vpMbHiddenFaces< PolygonType >::setOgreShowConfigDialog ( bool  showConfigDialog)
inline

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

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

Definition at line 254 of file vpMbHiddenFaces.h.

Referenced by vpMbTracker::computeProjectionErrorImpl(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbKltTracker::init(), vpMbEdgeTracker::init(), and vpMbGenericTracker::track().

◆ setVisible() [1/3]

template<class PolygonType >
unsigned int vpMbHiddenFaces< PolygonType >::setVisible ( unsigned int  width,
unsigned int  height,
const vpCameraParameters cam,
const vpHomogeneousMatrix cMo,
const double &  angle,
bool &  changed 
)

Compute the number of visible polygons.

Parameters
width,height: Image size used to check if the region of interest is inside the image.
cam: Camera parameters.
cMo: The pose of the camera.
angle: Angle used to test the appearance and disappearance of a face.
changed: True if a face appeared, disappeared or too many points have been lost. False otherwise.
Returns
Return the number of visible polygons

Definition at line 662 of file vpMbHiddenFaces.h.

Referenced by vpMbDepthDenseTracker::computeVisibility(), vpMbDepthNormalTracker::computeVisibility(), vpMbDepthDenseTracker::getModelForDisplay(), vpMbDepthNormalTracker::getModelForDisplay(), vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbKltTracker::init(), vpMbKltTracker::postTracking(), vpMbTracker::projectionErrorVisibleFace(), vpMbHiddenFaces< vpMbtPolygon >::setOgreShowConfigDialog(), vpMbKltTracker::setPose(), vpMbHiddenFaces< vpMbtPolygon >::setVisible(), vpMbGenericTracker::track(), and vpMbEdgeTracker::visibleFace().

◆ setVisible() [2/3]

template<class PolygonType >
unsigned int vpMbHiddenFaces< PolygonType >::setVisible ( unsigned int  width,
unsigned int  height,
const vpCameraParameters cam,
const vpHomogeneousMatrix cMo,
const double &  angleAppears,
const double &  angleDisappears,
bool &  changed 
)

Compute the number of visible polygons.

Parameters
width,height: Image size used to check if the region of interest is inside the image.
cam: Camera parameters.
cMo: The pose of the camera.
changed: True if a face appeared, disappeared or too many points have been lost. False otherwise.
angleAppears: Angle used to test the appearance of a face.
angleDisappears: Angle used to test the disappearance of a face.
Returns
Return the number of visible polygons

Definition at line 684 of file vpMbHiddenFaces.h.

◆ setVisible() [3/3]

template<class PolygonType >
unsigned int vpMbHiddenFaces< PolygonType >::setVisible ( const vpHomogeneousMatrix cMo,
const double &  angleAppears,
const double &  angleDisappears,
bool &  changed 
)

Compute the number of visible polygons.

Parameters
cMo: The pose of the camera
angleAppears: Angle used to test the appearance of a face
angleDisappears: Angle used to test the disappearance of a face
changed: True if a face appeared, disappeared or too many points have been lost. False otherwise
Returns
Return the number of visible polygons

Definition at line 703 of file vpMbHiddenFaces.h.

◆ setVisibleOgre() [1/2]

template<class PolygonType >
unsigned int vpMbHiddenFaces< PolygonType >::setVisibleOgre ( unsigned int  width,
unsigned int  height,
const vpCameraParameters cam,
const vpHomogeneousMatrix cMo,
const double &  angleAppears,
const double &  angleDisappears,
bool &  changed 
)

Compute the number of visible polygons through Ogre3D.

Parameters
width,height: Image size used to check if the region of interest is inside the image.
cam: Camera parameters.
cMo: The pose of the camera.
changed: True if a face appeared, disappeared or too many points have been lost. False otherwise.
angleAppears: Angle used to test the appearance of a face.
angleDisappears: Angle used to test the disappearance of a face.
Returns
Return the number of visible polygons

Definition at line 775 of file vpMbHiddenFaces.h.

Referenced by vpMbDepthDenseTracker::init(), vpMbDepthNormalTracker::init(), vpMbKltTracker::init(), vpMbKltTracker::postTracking(), vpMbTracker::projectionErrorVisibleFace(), vpMbHiddenFaces< vpMbtPolygon >::setOgreShowConfigDialog(), vpMbKltTracker::setPose(), vpMbGenericTracker::track(), and vpMbEdgeTracker::visibleFace().

◆ setVisibleOgre() [2/2]

template<class PolygonType >
unsigned int vpMbHiddenFaces< PolygonType >::setVisibleOgre ( const vpHomogeneousMatrix cMo,
const double &  angleAppears,
const double &  angleDisappears,
bool &  changed 
)

Compute the number of visible polygons through Ogre3D.

Parameters
cMo: The pose of the camera
angleAppears: Angle used to test the appearance of a face
angleDisappears: Angle used to test the disappearance of a face
changed: True if a face appeared, disappeared or too many points have been lost. False otherwise
Returns
Return the number of visible polygons

Definition at line 795 of file vpMbHiddenFaces.h.

◆ size()

Friends And Related Function Documentation

◆ swap

template<class PolygonType = vpMbtPolygon>
void swap ( vpMbHiddenFaces< PolygonType > &  first,
vpMbHiddenFaces< PolygonType > &  second 
)
friend

Definition at line 346 of file vpMbHiddenFaces.h.

Referenced by vpMbHiddenFaces< vpMbtPolygon >::operator=().