#include <visp3/visual_features/vpFeatureMomentBasic.h>

Inheritance diagram for vpFeatureMomentBasic:

Public Types
enum	{ FEATURE_ALL = 0xffff }

enum	vpBasicFeatureDeallocatorType { user, vpServo }

Public Member Functions
	vpFeatureMomentBasic (vpMomentDatabase &moments, double A, double B, double C, vpFeatureMomentDatabase *featureMoments=NULL)

void	compute_interaction ()

vpMatrix	interaction (unsigned int select_one, unsigned int select_two) const

const char *	momentName () const

const char *	name () const

Inherited functionalities from vpFeatureMoment
vpBasicFeature *	duplicate () const

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

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

int	getDimension (unsigned int select=FEATURE_ALL) const

void	init (void)

vpMatrix	interaction (const unsigned int select=FEATURE_ALL)

void	linkTo (vpFeatureMomentDatabase &featureMoments)

void	print (const unsigned int select=FEATURE_ALL) const

virtual void	printDependencies (std::ostream &os) const

void	update (double A, double B, double C)

Inherited functionalities from vpBasicFeature
unsigned int	dimension_s ()

virtual vpColVector	error (const vpBasicFeature &s_star, const unsigned int select=FEATURE_ALL)

vpColVector	get_s (unsigned int select=FEATURE_ALL) const

vpBasicFeatureDeallocatorType	getDeallocate ()

virtual double	operator[] (const unsigned int i) const

void	setDeallocate (vpBasicFeatureDeallocatorType d)

void	setFlags ()

Static Public Member Functions
static unsigned int	selectAll ()

Static Public Attributes
static const unsigned int	FEATURE_LINE [32]

Protected Member Functions
const vpMoment &	getMoment () const

void	resetFlags ()

Protected Attributes
unsigned int	order

const vpMoment *	moment

vpMomentDatabase &	moments

vpFeatureMomentDatabase *	featureMomentsDataBase

std::vector< vpMatrix >	interaction_matrices

double	A

double	B

double	C

char	_name [255]

vpColVector	s

unsigned int	dim_s

bool *	flags

unsigned int	nbParameters

vpBasicFeatureDeallocatorType	deallocate

Detailed Description

Functionality computation for basic moment feature. Computes the interaction matrix associated with vpMomentBasic.

The interaction matrix for the basic moment feature is defined in [38], equation (13). This vpFeatureMoment, as well as it's corresponding moment primitive is double-indexed. The interaction matrix $L_{m_{ij}}$ is obtained by calling vpFeatureMomentBasic::interaction (i,j) and is associated to $m_{ij}$ obtained by vpMomentBasic::get (i,j). vpFeatureMomentBasic computes interaction matrices all interaction matrices up to vpMomentObject::getOrder()-1.

Attention: The maximum order reached by vpFeatureMomentBasic is NOT the maximum order of the vpMomentObject, it is one unit smaller. For example if you define your vpMomentObject up to order n then vpFeatureMomentBasic will be able to compute interaction matrices up to order n-1 that is $L_{m_{ij}}$ with .

You can see an example of vpFeatureMomentBasic by looking at the documentation of the vpFeatureMoment class.

This feature depends on:

vpMomentBasic

Definition at line 80 of file vpFeatureMomentBasic.h.

Member Enumeration Documentation

anonymous enum

inherited

Enumerator
FEATURE_ALL

Definition at line 82 of file vpBasicFeature.h.

enum vpBasicFeature::vpBasicFeatureDeallocatorType

inherited

Indicates who should deallocate the feature.

Enumerator
user
vpServo

Definition at line 88 of file vpBasicFeature.h.

Constructor & Destructor Documentation

vpFeatureMomentBasic::vpFeatureMomentBasic	(	vpMomentDatabase &	data_base,
		double	A_,
		double	B_,
		double	C_,
		vpFeatureMomentDatabase *	featureMoments = `NULL`
	)

Default constructor.

Parameters

data_base	: Database of moment primitives.
A_	: First plane coefficient for a plane equation of the following type Ax+By+C=1/Z.
B_	: Second plane coefficient for a plane equation of the following type Ax+By+C=1/Z.
C_	: Third plane coefficient for a plane equation of the following type Ax+By+C=1/Z.
featureMoments	: Database of features.

Definition at line 53 of file vpFeatureMomentBasic.cpp.

Member Function Documentation

void vpFeatureMomentBasic::compute_interaction ( void )

virtual

Computes interaction matrix for basic moment. Called internally. The moment primitives must be computed before calling this.

Reimplemented from vpFeatureMoment.

Definition at line 63 of file vpFeatureMomentBasic.cpp.

References vpFeatureMoment::A, vpFeatureMoment::B, vpFeatureMoment::C, vpMomentObject::DISCRETE, vpMomentObject::get(), vpMoment::getObject(), vpMomentObject::getOrder(), vpMomentObject::getType(), vpFeatureMoment::interaction_matrices, vpFeatureMoment::moment, and order.

unsigned int vpBasicFeature::dimension_s ( )

inlineinherited

Return the dimension of the feature vector $\bf s$ .

Definition at line 110 of file vpBasicFeature.h.

References vpColor::green.

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

virtualinherited

Not implemented since visual representation of a moment doesn't often make sense.

Implements vpBasicFeature.

Definition at line 114 of file vpFeatureMoment.cpp.

void vpFeatureMoment::display	(	const vpCameraParameters &	cam,
		const vpImage< vpRGBa > &	I,
		const vpColor &	color = `vpColor::green`,
		unsigned int	thickness = `1`
	)		const

virtualinherited

Not implemented since visual representation of a moment doesn't often make sense.

Implements vpBasicFeature.

Definition at line 128 of file vpFeatureMoment.cpp.

vpBasicFeature * vpFeatureMoment::duplicate ( ) const

virtualinherited

Duplicates the feature into a vpGenericFeature harbouring the same properties. The resulting feature is of vpMomentGenericFeature type. While it still can compute interaction matrices and has acces to it's moment primitive, it has lost all precise information about its precise type and therefore cannot be used in a feature database.

Returns: The corresponding feature.

Implements vpBasicFeature.

Definition at line 220 of file vpFeatureMoment.cpp.

References vpFeatureMoment::A, vpFeatureMoment::B, vpFeatureMoment::C, vpBasicFeature::dim_s, vpFeatureMoment::featureMomentsDataBase, vpBasicFeature::flags, vpFeatureMoment::interaction_matrices, vpFeatureMoment::moment, vpFeatureMoment::moments, vpBasicFeature::nbParameters, vpColVector::resize(), and vpBasicFeature::s.

vpColVector vpBasicFeature::error	(	const vpBasicFeature &	s_star,
		const unsigned int	select = `FEATURE_ALL`
	)

virtualinherited

Compute the error between two visual features from a subset of the possible features.

Reimplemented in vpFeatureTranslation, vpFeaturePointPolar, vpFeatureThetaU, vpFeaturePoint3D, vpFeatureLine, vpFeaturePoint, vpGenericFeature, vpFeatureMomentAlpha, vpFeatureDepth, vpFeatureLuminance, vpFeatureEllipse, vpFeatureVanishingPoint, and vpFeatureSegment.

Examples:: manServoMomentsSimple.cpp.

Definition at line 151 of file vpBasicFeature.cpp.

References vpBasicFeature::dim_s, vpBasicFeature::FEATURE_LINE, vpBasicFeature::get_s(), and vpBasicFeature::s.

Referenced by vpServo::computeError(), vpFeatureMomentAlpha::name(), vpFeatureDepth::~vpFeatureDepth(), vpFeatureEllipse::~vpFeatureEllipse(), vpFeatureLine::~vpFeatureLine(), vpFeaturePoint::~vpFeaturePoint(), vpFeaturePoint3D::~vpFeaturePoint3D(), vpFeaturePointPolar::~vpFeaturePointPolar(), vpFeatureSegment::~vpFeatureSegment(), vpFeatureThetaU::~vpFeatureThetaU(), vpFeatureTranslation::~vpFeatureTranslation(), and vpFeatureVanishingPoint::~vpFeatureVanishingPoint().

vpColVector vpBasicFeature::get_s ( unsigned int select = FEATURE_ALL ) const

inherited

Get the feature vector $\bf s$ .

Examples:: servoAfma6Ellipse2DCamVelocity.cpp.

Definition at line 114 of file vpBasicFeature.cpp.

References vpBasicFeature::dim_s, vpBasicFeature::FEATURE_LINE, vpBasicFeature::s, and vpColVector::stack().

Referenced by vpServo::computeError(), vpBasicFeature::error(), vpFeatureDepth::error(), vpGenericFeature::error(), vpFeatureThetaU::error(), vpFeatureTranslation::error(), and vpGenericFeature::getInteractionMatrix().

vpBasicFeatureDeallocatorType vpBasicFeature::getDeallocate ( )

inlineinherited

Definition at line 123 of file vpBasicFeature.h.

int vpFeatureMoment::getDimension ( unsigned int select = FEATURE_ALL ) const

inherited

Feature's dimension according to selection.

Definition at line 85 of file vpFeatureMoment.cpp.

References vpBasicFeature::dim_s, and vpBasicFeature::FEATURE_LINE.

const vpMoment& vpFeatureMoment::getMoment ( ) const

inlineprotectedinherited

Definition at line 163 of file vpFeatureMoment.h.

void vpFeatureMoment::init ( void )

virtualinherited

Initialize common parameters for moment features.

Implements vpBasicFeature.

Definition at line 56 of file vpFeatureMoment.cpp.

References vpBasicFeature::dim_s, vpBasicFeature::flags, vpMoment::get(), vpFeatureMoment::moment, vpBasicFeature::nbParameters, vpColVector::resize(), and vpBasicFeature::s.

vpMatrix vpFeatureMomentBasic::interaction	(	unsigned int	select_one,
		unsigned int	select_two
	)		const

Interaction matrix corresponding to $m_{ij}$ moment.

Parameters

select_one	: first index (i).
select_two	: second index (j).

Returns: Interaction matrix $L_{m_{ij}}$ corresponding to the moment.

Definition at line 159 of file vpFeatureMomentBasic.cpp.

References vpException::badValue, vpMoment::getObject(), vpMomentObject::getOrder(), vpFeatureMoment::interaction_matrices, vpFeatureMoment::moment, and order.

Referenced by vpFeatureMomentCInvariant::compute_interaction(), and vpFeatureMomentCentered::compute_Lmu_pq().

vpMatrix vpFeatureMoment::interaction ( const unsigned int select = FEATURE_ALL )

virtualinherited

Retrieves the interaction matrix. No computation is done.

Parameters

select : Feature selector.

Returns: The corresponding interaction matrix.

There is no rule about the format of the feature selector. It may be different for different features. For example, for vpFeatureMomentBasic or vpFeatureMomentCentered features, select may refer to the $ (i,j) $ couple in the $j \times order + i$ format, but for vpFeatureMomentCInvariant the selector allows to select couples $ (i,j,k,l...) $ in the following format: 1 << i

1 << j + 1 << k + 1 << l.

Implements vpBasicFeature.

Definition at line 199 of file vpFeatureMoment.cpp.

References vpBasicFeature::dim_s, vpBasicFeature::FEATURE_LINE, vpFeatureMoment::interaction_matrices, and vpMatrix::stack().

Referenced by vpFeatureMomentCentered::compute_interaction().

void vpFeatureMoment::linkTo ( vpFeatureMomentDatabase & featureMoments )

inherited

Links the feature to the feature's database. NB: The feature's database is different from the moment's database.

Parameters

featureMoments : database in which the moment features are stored.

Definition at line 244 of file vpFeatureMoment.cpp.

References vpFeatureMoment::_name, vpFeatureMoment::featureMomentsDataBase, vpException::memoryAllocationError, and vpFeatureMoment::name().

Referenced by vpFeatureMomentCommon::vpFeatureMomentCommon().

const char* vpFeatureMomentBasic::momentName ( ) const

inlinevirtual

Associated moment name.

Implements vpFeatureMoment.

Definition at line 102 of file vpFeatureMomentBasic.h.

const char* vpFeatureMomentBasic::name ( ) const

inlinevirtual

Feature name.

Implements vpFeatureMoment.

Definition at line 106 of file vpFeatureMomentBasic.h.

virtual double vpBasicFeature::operator[] ( const unsigned int i ) const

inlinevirtualinherited

Return element i in the state vector (usage : x = s[i] )

Definition at line 130 of file vpBasicFeature.h.

void vpFeatureMoment::print ( const unsigned int select = FEATURE_ALL ) const

virtualinherited

Outputs the content of the feature: it's corresponding selected moments.

Implements vpBasicFeature.

Definition at line 99 of file vpFeatureMoment.cpp.

References vpBasicFeature::dim_s, vpBasicFeature::FEATURE_LINE, and vpBasicFeature::s.

void vpFeatureMoment::printDependencies ( std::ostream & os ) const

virtualinherited

Interface function to display the moments and other interaction matrices on which a particular vpFeatureMoment is dependent upon Not made pure to maintain compatibility Recommended : Types inheriting from vpFeatureMoment should implement this function

Definition at line 281 of file vpFeatureMoment.cpp.

void vpBasicFeature::resetFlags ( )

protectedinherited

Definition at line 131 of file vpBasicFeature.cpp.

References vpBasicFeature::flags, and vpBasicFeature::nbParameters.

Referenced by vpFeatureVanishingPoint::interaction(), vpFeatureEllipse::interaction(), vpFeatureDepth::interaction(), vpFeaturePoint::interaction(), vpFeatureLine::interaction(), vpFeaturePoint3D::interaction(), vpFeatureThetaU::interaction(), vpFeaturePointPolar::interaction(), and vpFeatureTranslation::interaction().

static unsigned int vpBasicFeature::selectAll ( )

inlinestaticinherited

Select all the features.

Definition at line 142 of file vpBasicFeature.h.

void vpBasicFeature::setDeallocate ( vpBasicFeatureDeallocatorType d )

inlineinherited

Definition at line 137 of file vpBasicFeature.h.

Referenced by vpServo::addFeature().

void vpBasicFeature::setFlags ( )

inherited

Set feature flags to true to prevent warning when re-computing the interaction matrix without having updated the feature.

Definition at line 141 of file vpBasicFeature.cpp.

References vpBasicFeature::flags, and vpBasicFeature::nbParameters.

void vpFeatureMoment::update	(	double	A_,
		double	B_,
		double	C_
	)

inherited

Updates the interaction matrices with the image plane the camera is facing. The plane must be in the format: $\frac{1}{Z}=Ax+By+C$ . The moment primitives MUST be updated before calling this function.

This method also computes the interaction matrix. Therefore, you must call vpFeatureMoment::update before calling vpFeatureMoment::interaction.

Attention: The behaviour of this method is not the same as vpMoment::update which only acknowledges the new object. This method also computes the interaction matrices.

Parameters

A_	: A coefficient of the plane.
B_	: B coefficient of the plane.
C_	: C coefficient of the plane.

Examples:: mbot-apriltag-ibvs.cpp.

Definition at line 153 of file vpFeatureMoment.cpp.

References vpFeatureMoment::A, vpFeatureMoment::B, vpFeatureMoment::C, vpFeatureMoment::compute_interaction(), vpBasicFeature::dim_s, vpBasicFeature::flags, vpMomentDatabase::get(), vpMoment::get(), vpFeatureMoment::moment, vpFeatureMoment::momentName(), vpFeatureMoment::moments, vpBasicFeature::nbParameters, vpException::notInitialized, vpColVector::resize(), and vpBasicFeature::s.

Referenced by vpFeatureMomentCommon::updateAll().

Member Data Documentation

char vpFeatureMoment::_name[255]

protectedinherited

Definition at line 171 of file vpFeatureMoment.h.

Referenced by vpFeatureMoment::linkTo().

double vpFeatureMoment::A

protectedinherited

Definition at line 168 of file vpFeatureMoment.h.

Referenced by vpFeatureMomentArea::compute_interaction(), compute_interaction(), vpFeatureMomentCentered::compute_interaction(), vpFeatureMomentAlpha::compute_interaction(), vpFeatureMomentAreaNormalized::compute_interaction(), vpFeatureMomentGravityCenter::compute_interaction(), vpFeatureMomentGravityCenterNormalized::compute_interaction(), vpFeatureMoment::duplicate(), and vpFeatureMoment::update().

double vpFeatureMoment::B

protectedinherited

Definition at line 169 of file vpFeatureMoment.h.

Referenced by vpFeatureMomentArea::compute_interaction(), compute_interaction(), vpFeatureMomentCentered::compute_interaction(), vpFeatureMomentAlpha::compute_interaction(), vpFeatureMomentAreaNormalized::compute_interaction(), vpFeatureMomentGravityCenter::compute_interaction(), vpFeatureMomentGravityCenterNormalized::compute_interaction(), vpFeatureMoment::duplicate(), and vpFeatureMoment::update().

double vpFeatureMoment::C

protectedinherited

Definition at line 170 of file vpFeatureMoment.h.

Referenced by vpFeatureMomentArea::compute_interaction(), compute_interaction(), vpFeatureMomentCentered::compute_interaction(), vpFeatureMomentAreaNormalized::compute_interaction(), vpFeatureMomentGravityCenter::compute_interaction(), vpFeatureMomentGravityCenterNormalized::compute_interaction(), vpFeatureMoment::duplicate(), and vpFeatureMoment::update().

vpBasicFeatureDeallocatorType vpBasicFeature::deallocate

protectedinherited

Definition at line 148 of file vpBasicFeature.h.

Referenced by vpFeatureVanishingPoint::interaction(), vpFeatureEllipse::interaction(), vpFeatureSegment::interaction(), vpFeatureDepth::interaction(), vpFeaturePoint::interaction(), vpFeatureLine::interaction(), vpFeaturePoint3D::interaction(), vpFeatureThetaU::interaction(), vpFeaturePointPolar::interaction(), vpFeatureTranslation::interaction(), and vpBasicFeature::operator=().

unsigned int vpBasicFeature::dim_s

protectedinherited

Dimension of the visual feature.

Definition at line 94 of file vpBasicFeature.h.

Referenced by vpGenericFeature::duplicate(), vpFeatureMoment::duplicate(), vpFeatureLuminance::error(), vpBasicFeature::error(), vpGenericFeature::error(), vpBasicFeature::get_s(), vpGenericFeature::get_s(), vpBasicFeature::getDimension(), vpFeatureMoment::getDimension(), vpFeatureVanishingPoint::init(), vpFeatureEllipse::init(), vpFeatureLuminance::init(), vpFeatureSegment::init(), vpFeatureDepth::init(), vpFeaturePoint::init(), vpFeatureMoment::init(), vpFeatureLine::init(), vpFeaturePoint3D::init(), vpFeatureThetaU::init(), vpFeaturePointPolar::init(), vpFeatureTranslation::init(), vpFeatureLuminance::interaction(), vpGenericFeature::interaction(), vpFeatureMoment::interaction(), vpFeatureLuminance::operator=(), vpBasicFeature::operator=(), vpGenericFeature::print(), vpFeatureMoment::print(), vpGenericFeature::set_s(), vpGenericFeature::setError(), vpGenericFeature::setInteractionMatrix(), vpFeatureMoment::update(), vpFeatureLuminance::vpFeatureLuminance(), and vpGenericFeature::vpGenericFeature().

const unsigned int vpBasicFeature::FEATURE_LINE

staticinherited

Initial value:

= {
    (unsigned int)(1 << 0),  (unsigned int)(1 << 1),  (unsigned int)(1 << 2),  (unsigned int)(1 << 3),
    (unsigned int)(1 << 4),  (unsigned int)(1 << 5),  (unsigned int)(1 << 6),  (unsigned int)(1 << 7),
    (unsigned int)(1 << 8),  (unsigned int)(1 << 9),  (unsigned int)(1 << 10), (unsigned int)(1 << 11),
    (unsigned int)(1 << 12), (unsigned int)(1 << 13), (unsigned int)(1 << 14), (unsigned int)(1 << 15),
    (unsigned int)(1 << 16), (unsigned int)(1 << 17), (unsigned int)(1 << 18), (unsigned int)(1 << 19),
    (unsigned int)(1 << 20), (unsigned int)(1 << 21), (unsigned int)(1 << 22), (unsigned int)(1 << 23),
    (unsigned int)(1 << 24), (unsigned int)(1 << 25), (unsigned int)(1 << 26), (unsigned int)(1 << 27),
    (unsigned int)(1 << 28), (unsigned int)(1 << 29), (unsigned int)(1 << 30), (unsigned int)(1 << 31)}

Definition at line 80 of file vpBasicFeature.h.

Referenced by vpBasicFeature::error(), vpGenericFeature::error(), vpBasicFeature::get_s(), vpBasicFeature::getDimension(), vpFeatureMoment::getDimension(), vpGenericFeature::interaction(), vpFeatureMoment::interaction(), vpGenericFeature::print(), vpFeatureMoment::print(), vpFeatureSegment::selectAlpha(), vpFeatureSegment::selectL(), vpFeatureEllipse::selectMu02(), vpFeatureEllipse::selectMu11(), vpFeatureEllipse::selectMu20(), vpFeatureLine::selectRho(), vpFeaturePointPolar::selectRho(), vpFeatureLine::selectTheta(), vpFeaturePointPolar::selectTheta(), vpFeatureThetaU::selectTUx(), vpFeatureThetaU::selectTUy(), vpFeatureThetaU::selectTUz(), vpFeatureTranslation::selectTx(), vpFeatureTranslation::selectTy(), vpFeatureTranslation::selectTz(), vpFeatureVanishingPoint::selectX(), vpFeatureEllipse::selectX(), vpFeaturePoint::selectX(), vpFeaturePoint3D::selectX(), vpFeatureSegment::selectXc(), vpFeatureVanishingPoint::selectY(), vpFeatureEllipse::selectY(), vpFeaturePoint::selectY(), vpFeaturePoint3D::selectY(), vpFeatureSegment::selectYc(), and vpFeaturePoint3D::selectZ().

vpFeatureMomentDatabase* vpFeatureMoment::featureMomentsDataBase

protectedinherited

Definition at line 165 of file vpFeatureMoment.h.

Referenced by vpFeatureMomentCentered::compute_interaction(), vpFeatureMomentCInvariant::compute_interaction(), vpFeatureMoment::duplicate(), and vpFeatureMoment::linkTo().

bool* vpBasicFeature::flags

protectedinherited

Ensure that all the parameters needed to compute the iteraction matrix are set.

Definition at line 98 of file vpBasicFeature.h.

std::vector<vpMatrix> vpFeatureMoment::interaction_matrices

protectedinherited

Definition at line 166 of file vpFeatureMoment.h.

const vpMoment* vpFeatureMoment::moment

protectedinherited

Definition at line 162 of file vpFeatureMoment.h.

vpMomentDatabase& vpFeatureMoment::moments

protectedinherited

Definition at line 164 of file vpFeatureMoment.h.

Referenced by vpFeatureMomentArea::compute_interaction(), vpFeatureMomentCentered::compute_interaction(), vpFeatureMomentAlpha::compute_interaction(), vpFeatureMomentAreaNormalized::compute_interaction(), vpFeatureMomentGravityCenter::compute_interaction(), vpFeatureMomentCInvariant::compute_interaction(), vpFeatureMomentGravityCenterNormalized::compute_interaction(), vpFeatureMoment::duplicate(), and vpFeatureMoment::update().

unsigned int vpBasicFeature::nbParameters

protectedinherited

Number of parameters needed to compute the interaction matrix.

Definition at line 100 of file vpBasicFeature.h.

unsigned int vpFeatureMomentBasic::order

protected

Definition at line 83 of file vpFeatureMomentBasic.h.

Referenced by compute_interaction(), and interaction().

vpColVector vpBasicFeature::s

protectedinherited

State of the visual feature.

Definition at line 92 of file vpBasicFeature.h.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation