Visual Servoing Platform  version 3.0.0
Public Types | Public Member Functions | Public Attributes | List of all members
vpForwardProjection Class Referenceabstract

#include <visp3/core/vpForwardProjection.h>

+ Inheritance diagram for vpForwardProjection:

Public Types

enum  vpForwardProjectionDeallocatorType { user, vpDisplayForwardProjection }
 

Public Member Functions

virtual void init ()=0
 
virtual ~vpForwardProjection ()
 
virtual void setWorldCoordinates (const vpColVector &oP)=0
 
virtual void changeFrame (const vpHomogeneousMatrix &cMo, vpColVector &cP)=0
 
virtual void changeFrame (const vpHomogeneousMatrix &cMo)=0
 
virtual void projection (const vpColVector &cP, vpColVector &p)=0
 
virtual void projection ()=0
 
void project ()
 
void project (const vpHomogeneousMatrix &cMo)
 
void track (const vpHomogeneousMatrix &cMo)
 
virtual void display (const vpImage< unsigned char > &I, const vpCameraParameters &cam, const vpColor &color=vpColor::green, const unsigned int thickness=1)=0
 
virtual void display (const vpImage< unsigned char > &I, const vpHomogeneousMatrix &cMo, const vpCameraParameters &cam, const vpColor &color=vpColor::green, const unsigned int thickness=1)=0
 
virtual void print () const
 
virtual vpForwardProjection * duplicate () const =0
 
 vpForwardProjection ()
 
void setDeallocate (vpForwardProjectionDeallocatorType d)
 
vpForwardProjectionDeallocatorType getDeallocate ()
 

Public Attributes

vpColVector oP
 
vpColVector p
 
vpColVector cP
 
bool cPAvailable
 

Detailed Description

Class that defines what is a generic geometric feature.

Each geometric feature has parameters expressed:

  • in the object frame oP. These parameters are located in the public attribute vpForwardProjection::oP.
  • in the camera frame cP. These parameters are located in the public attribute vpTracker::cP.
  • in the image plane p. These parameters are located in the public attribute vpTracker::p. They correspond to normalized coordinates of the feature expressed in meters.

Definition at line 67 of file vpForwardProjection.h.

Member Enumeration Documentation

enum vpForwardProjection::vpForwardProjectionDeallocatorType

Used for memory issue especially in the vpServo class.

Enumerator
user 
vpDisplayForwardProjection 

Definition at line 215 of file vpForwardProjection.h.

Constructor & Destructor Documentation

virtual vpForwardProjection::~vpForwardProjection ( )
inlinevirtual

Destructor.

Definition at line 85 of file vpForwardProjection.h.

vpForwardProjection::vpForwardProjection ( )
inline

Definition at line 224 of file vpForwardProjection.h.

Member Function Documentation

virtual void vpForwardProjection::changeFrame ( const vpHomogeneousMatrix &  cMo,
vpColVector &  cP 
)
pure virtual

Computes the features parameters in the camera frame (cP) thanks to the parameters given in the object frame (vpForwardProjection::oP) and the homogeneous matrix relative to the pose (cMo) between the object frame and the camera frame.

To set the parameters in the object frame you need to call setWorldCoordinates().

Parameters
cMo: The homogeneous matrix corresponding to the pose between the camera frame and the object frame.
cP: The vector which will contain the feature parameters expressed in the camera frame.

With this method, the vpTracker::cP public attribute is not updated.

Implemented in vpLine, vpCylinder, vpCircle, vpSphere, and vpPoint.

Referenced by project().

virtual void vpForwardProjection::changeFrame ( const vpHomogeneousMatrix &  cMo)
pure virtual

Computes the features parameters in the camera frame (cP) thanks to the parameters given in the object frame (vpForwardProjection::oP) and the homogeneous matrix relative to the pose (cMo) between the object frame and the camera frame.

To set the parameters in the object frame you need to call setWorldCoordinates().

Parameters
cMo: The homogeneous matrix corresponding to the pose between the camera frame and the object frame.

The features parameters in the camera frame (cP) are updated in the vpTracker::cP public attribute.

Implemented in vpLine, vpCylinder, vpCircle, vpSphere, and vpPoint.

virtual void vpForwardProjection::display ( const vpImage< unsigned char > &  I,
const vpCameraParameters &  cam,
const vpColor &  color = vpColor::green,
const unsigned int  thickness = 1 
)
pure virtual

Displays the feature in the image I thanks to the 2D feature parameters in the image plane (vpTracker::p) and the camera parameters which enable to convert the features from meter to pixel.

Parameters
I: The image where the feature must be displayed in overlay.
cam: The camera parameters to enable the conversion from meter to pixel.
color: The desired color to display the line in the image.
thickness: Thickness of the feature representation.

Implemented in vpLine, vpCylinder, vpCircle, vpSphere, and vpPoint.

Referenced by vpProjectionDisplay::display().

virtual void vpForwardProjection::display ( const vpImage< unsigned char > &  I,
const vpHomogeneousMatrix &  cMo,
const vpCameraParameters &  cam,
const vpColor &  color = vpColor::green,
const unsigned int  thickness = 1 
)
pure virtual

Displays the feature in the image I thanks to the features in the object frame (vpForwardProjection::oP), the homogeneous matrix relative to the pose between the object frame and the camera frame and the camera parameters which enable to convert the features from meter to pixel.

Parameters
I: The image where the line must be displayed in overlay.
cMo: The homogeneous matrix corresponding to the pose between the camera frame and the object frame.
cam: The camera parameters to enable the conversion from meter to pixel.
color: The desired color to display the line in the image.
thickness: Thickness of the feature representation.

Implemented in vpLine, vpCylinder, vpCircle, vpSphere, and vpPoint.

virtual vpForwardProjection* vpForwardProjection::duplicate ( ) const
pure virtual

Create an object with the same type.

Implemented in vpLine, vpCylinder, vpCircle, vpSphere, and vpPoint.

vpForwardProjectionDeallocatorType vpForwardProjection::getDeallocate ( )
inline

Definition at line 227 of file vpForwardProjection.h.

virtual void vpForwardProjection::init ( )
pure virtual

Default initialisation of the feature parameters:

  • in the object frame: oP
  • in the camera frame: cP
  • in the image plane: p.

Implemented in vpCylinder, vpLine, vpPoint, vpSphere, and vpCircle.

void vpForwardProjection::print ( ) const
virtual

Print to stdout the feature parameters in:

  • the object frame
  • the camera frame
  • the image plane.
Examples:
servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, and servoSimuSquareLine2DCamVelocityDisplay.cpp.

Definition at line 59 of file vpForwardProjection.cpp.

References vpTracker::cP, oP, vpTracker::p, and vpColVector::t().

void vpForwardProjection::project ( )

Compute the feature parameters in the image plane (vpTracker::p) from the parameters in the camera frame (vpTracker::cP).

Warning
Be careful to update vpTracker::p and vpTracker::cP public attributes before the call of this method.
Examples:
homographyHartleyDLT2DObject.cpp, homographyHLM2DObject.cpp, homographyHLM3DObject.cpp, manGeometricFeatures.cpp, manServo4PointsDisplay.cpp, manSimu4Points.cpp, servoAfma62DhalfCamVelocity.cpp, servoAfma6Cylinder2DCamVelocity.cpp, servoAfma6Cylinder2DCamVelocitySecondaryTask.cpp, servoAfma6Line2DCamVelocity.cpp, servoAfma6SquareLines2DCamVelocity.cpp, servoAfma6TwoLines2DCamVelocity.cpp, servoPioneerPanSegment3D.cpp, simulateFourPoints2DPolarCamVelocity.cpp, testFeatureSegment.cpp, testFindMatch.cpp, testPose.cpp, and testPoseFeatures.cpp.

Definition at line 75 of file vpForwardProjection.cpp.

References vpTracker::cP, vpTracker::p, and projection().

Referenced by vpMbtDistanceKltCylinder::computeInteractionMatrixAndResidu(), vpMbTracker::getPolygonFaces(), vpKeyPoint::matchPointAndDetect(), and track().

void vpForwardProjection::project ( const vpHomogeneousMatrix &  cMo)

Compute the feature parameters in the camera frame (vpTracker::cP) and than compute the projection of these parameters in the image plane (vpTracker::p).

Warning
The feature parameters in the object frame (vpForwardProjection:oP) need to be set prior the use of this method. To initialize these parameters see setWorldCoordinates().
Parameters
cMo: The homogeneous matrix corresponding to the pose between the camera frame and the object frame.

Definition at line 95 of file vpForwardProjection.cpp.

References changeFrame(), projection(), and vpERROR_TRACE.

virtual void vpForwardProjection::projection ( const vpColVector &  cP,
vpColVector &  p 
)
pure virtual

Computes the feature parameters in the image plane from the parameters expressed in the camera frame.

Parameters
cP[input] : Feature parameters expressed in the camera frame.
p[output] : Feature parameters expressed in the image plane.

Implemented in vpLine, vpCylinder, vpPoint, vpCircle, and vpSphere.

virtual void vpForwardProjection::projection ( )
pure virtual

Computes the feature parameters in the image plane. These parameters are than updated in the vpTracker::p public attribute.

Warning
To compute these parameters, the method exploit the feature parameters in the camera frame. Thus, vpTracker::cP need to be updated before the call of this method. For that, a call to changeFrame(const vpHomogeneousMatrix &) is requested.

Implemented in vpLine, vpCylinder, vpPoint, vpCircle, and vpSphere.

Referenced by project().

void vpForwardProjection::setDeallocate ( vpForwardProjectionDeallocatorType  d)
inline

Definition at line 226 of file vpForwardProjection.h.

virtual void vpForwardProjection::setWorldCoordinates ( const vpColVector &  oP)
pure virtual

Sets the parameters which define the feature in the object frame.

Parameters
oP: Feature parameters expressed in the object frame used to set the vpForwardProjection::oP public attribute.

Implemented in vpLine, vpCylinder, vpPoint, vpSphere, and vpCircle.

void vpForwardProjection::track ( const vpHomogeneousMatrix &  cMo)

Track the feature parameters in the camera frame (vpTracker::cP) and than compute the projection of these parameters in the image plane (vpTracker::p).

This method is similar to project(const vpHomogeneousMatrix &).

Warning
The feature parameters in the object frame (vpForwardProjection:oP) need to be set prior the use of this method. To initialize these parameters see setWorldCoordinates().
Parameters
cMo: The homogeneous matrix corresponding to the pose between the camera frame and the object frame.
Examples:
servoSimu4Points.cpp, servoSimuAfma6FourPoints2DCamVelocity.cpp, servoSimuCircle2DCamVelocity.cpp, servoSimuCircle2DCamVelocityDisplay.cpp, servoSimuFourPoints2DCamVelocity.cpp, servoSimuFourPoints2DCamVelocityDisplay.cpp, servoSimuFourPoints2DPolarCamVelocityDisplay.cpp, servoSimuLine2DCamVelocityDisplay.cpp, servoSimuSphere.cpp, servoSimuSphere2DCamVelocity.cpp, servoSimuSphere2DCamVelocitySecondaryTask.cpp, servoSimuSquareLine2DCamVelocityDisplay.cpp, servoSimuViper850FourPoints2DCamVelocity.cpp, simulateCircle2DCamVelocity.cpp, simulateFourPoints2DCartesianCamVelocity.cpp, simulateFourPoints2DPolarCamVelocity.cpp, tutorial-ibvs-4pts-ogre.cpp, tutorial-ibvs-4pts-plotter-continuous-gain-adaptive.cpp, tutorial-ibvs-4pts-plotter-gain-adaptive.cpp, tutorial-ibvs-4pts-plotter.cpp, tutorial-ibvs-4pts.cpp, tutorial-simu-pioneer-continuous-gain-adaptive.cpp, tutorial-simu-pioneer-continuous-gain-constant.cpp, tutorial-simu-pioneer-pan.cpp, and tutorial-simu-pioneer.cpp.

Definition at line 126 of file vpForwardProjection.cpp.

References project(), and vpERROR_TRACE.

Referenced by vpPose::computeResidual(), vpProjectionDisplay::displayCamera(), vpDisplay::displayFrame(), vpPose::poseRansac(), vpPose::poseVirtualVS(), vpPose::poseVirtualVSrobust(), vpWireFrameSimulator::projectCameraTrajectory(), vpSimulatorAfma6::updateArticularPosition(), and vpSimulatorViper850::updateArticularPosition().

Member Data Documentation

vpColVector vpTracker::cP
inherited

Feature coordinates expressed in the camera frame cP.

Definition at line 77 of file vpTracker.h.

Referenced by vpFeaturePoint3D::buildFrom(), vpPoint::changeFrame(), vpSphere::changeFrame(), vpCircle::changeFrame(), vpCylinder::changeFrame(), vpLine::changeFrame(), vpFeatureBuilder::create(), vpPoint::get_W(), vpPoint::get_X(), vpPoint::get_Y(), vpPoint::get_Z(), vpCircle::init(), vpSphere::init(), vpPoint::init(), vpLine::init(), vpCylinder::init(), vpMbtPolygon::isVisible(), vpTracker::operator=(), vpPoint::operator=(), print(), vpPose::printPoint(), project(), vpCircle::projection(), vpSphere::projection(), vpPoint::projection(), vpCylinder::projection(), vpLine::projection(), vpPoint::set_W(), vpPoint::set_X(), vpPoint::set_Y(), and vpPoint::set_Z().

bool vpTracker::cPAvailable
inherited

Flag used to indicate if the feature parameters cP expressed in the camera frame are available.

Definition at line 83 of file vpTracker.h.

Referenced by vpTracker::init(), vpTracker::operator=(), and vpPoint::operator=().

vpColVector vpForwardProjection::oP

Feature coordinates expressed in the object frame, also called world frame.

Definition at line 73 of file vpForwardProjection.h.

Referenced by vpPoint::changeFrame(), vpCircle::changeFrame(), vpSphere::changeFrame(), vpCylinder::changeFrame(), vpLine::changeFrame(), vpPoint::get_oW(), vpPoint::get_oX(), vpPoint::get_oY(), vpPoint::get_oZ(), vpPoint::getWorldCoordinates(), vpCircle::init(), vpSphere::init(), vpPoint::init(), vpLine::init(), vpCylinder::init(), vpPoint::operator=(), print(), vpPose::printPoint(), vpPoint::set_oW(), vpPoint::set_oX(), vpPoint::set_oY(), vpPoint::set_oZ(), vpCircle::setWorldCoordinates(), vpSphere::setWorldCoordinates(), vpPoint::setWorldCoordinates(), vpLine::setWorldCoordinates(), and vpCylinder::setWorldCoordinates().

vpColVector vpTracker::p
inherited

Feature coordinates expressed in the image plane p. They correspond to 2D normalized coordinates expressed in meters.

Definition at line 73 of file vpTracker.h.

Referenced by vpMbtDistanceCircle::computeInteractionMatrixError(), vpCircle::computeIntersectionPoint(), vpMeterPixelConversion::convertEllipse(), vpFeatureBuilder::create(), vpPoint::display(), vpSphere::display(), vpCircle::display(), vpCylinder::display(), vpProjectionDisplay::display(), vpLine::display(), vpProjectionDisplay::displayCamera(), vpDisplay::displayFrame(), vpPose::displayModel(), vpPoint::get_w(), vpPoint::get_x(), vpPoint::get_y(), vpCircle::init(), vpSphere::init(), vpMeTracker::init(), vpPoint::init(), vpLine::init(), vpCylinder::init(), vpTracker::operator=(), vpPoint::operator=(), print(), vpPose::printPoint(), project(), vpCircle::projection(), vpSphere::projection(), vpPoint::projection(), vpCylinder::projection(), vpLine::projection(), vpPoint::set_w(), vpPoint::set_x(), and vpPoint::set_y().