Visual Servoing Platform  version 3.5.1 under development (2023-09-22)
vpMomentCentered Class Reference

#include <visp3/core/vpMomentCentered.h>

+ Inheritance diagram for vpMomentCentered:

Public Member Functions

 vpMomentCentered ()
 
virtual ~vpMomentCentered ()
 
void compute ()
 
double get (unsigned int i, unsigned int j) const
 
const std::vector< double > & get () const
 
const char * name () const
 
void printWithIndices (std::ostream &os) const
 
void printDependencies (std::ostream &os) const
 
Inherited functionalities from vpMoment
const vpMomentObjectgetObject () const
 
void linkTo (vpMomentDatabase &moments)
 
void update (vpMomentObject &object)
 

Protected Member Functions

void set (unsigned int i, unsigned int j, double value)
 
vpMomentDatabasegetMoments () const
 

Protected Attributes

std::vector< double > values
 

Friends

VISP_EXPORT std::ostream & operator<< (std::ostream &os, const vpMomentCentered &v)
 

Detailed Description

This class defines the double-indexed centered moment descriptor $\mu_{ij}$.

In the case of a dense object O, centered moments are defined by:

\[\mu_{ij}= \int \int_{O} (x_k-x_g)^j (y_k-y_g)^j\]

In the case of a discrete set of n points, centered moments are defined by:

\[\mu_{ij}= \sum_{k=1}^{n} (x_k-x_g)^j (y_k-y_g)^j\]

where $(x_g,y_g)$ are the coordinates of the center of gravity.

The centered moments are computed from the object at the highest possible order. For example if the vpMomentObject is defined up to order 5, vpMomentCentered will be too.

Values of vpMomentCentered may be accessed by one of the two vpMomentCentered::get methods. When using vpMomentCentered::get (), the format of the return vector is the following: $ \mu_{ij} $ is stored at vpMomentCentered::get ()[j* (vpMomentObject::getOrder () +1)+i]

vpMomentCentered depends on vpMomentGravityCenter.

Examples
mbot-apriltag-ibvs.cpp, servoBebop2.cpp, servoPixhawkDroneIBVS.cpp, and testMomentAlpha.cpp.

Definition at line 74 of file vpMomentCentered.h.

Constructor & Destructor Documentation

◆ vpMomentCentered()

vpMomentCentered::vpMomentCentered ( )

Default constructor.

Definition at line 95 of file vpMomentCentered.cpp.

◆ ~vpMomentCentered()

virtual vpMomentCentered::~vpMomentCentered ( )
inlinevirtual

Definition at line 78 of file vpMomentCentered.h.

Member Function Documentation

◆ compute()

◆ get() [1/2]

const std::vector< double > & vpMomentCentered::get ( ) const
inline

Returns all centered moment values $\mu_{ij}$ with $i+j \leq order$ where order is the object's order.

Returns
Vector of moment values. To access $\mu_{ij}$, you have to read vpMomentObject::get()[j*order+i].

For example, if the maximal order is 3, the following values are provided:

u00 u10 u20 u01 u11 u21 u02 u12 u12 u30 u03

To have a better reading of the moments you can picture them as a triangular matrix:

u00 u10 u20 u30 u01 u11 u21 x u02 u12 x x u30 x x x

The moments of the same order are on each of the matrix reverse diagonals. To access for example to the centered moment $\mu_{12}$, you should use this kind of code:

//[...]
mc.compute();
double mu12;
mu12 = mc.get()[2*(obj.getOrder()+1)+1]; // i=1 and j=2
mu12 = mc.get(1,2); // the same
This class defines the double-indexed centered moment descriptor .
double get(unsigned int i, unsigned int j) const

Definition at line 130 of file vpMomentCentered.h.

References vpMoment::get().

Referenced by printWithIndices().

◆ get() [2/2]

◆ getMoments()

◆ getObject()

◆ linkTo()

void vpMoment::linkTo ( vpMomentDatabase data_base)
inherited

Links the moment to a database of moment primitives. If the moment depends on other moments, these moments must be linked to the same database.

Attention
Two moments of the same class cannot be stored in the same database
#include <visp3/core/vpMomentCentered.h>
#include <visp3/core/vpMomentDatabase.h>
#include <visp3/core/vpMomentGravityCenter.h>
#include <visp3/core/vpMomentObject.h>
#include <visp3/core/vpPoint.h>
int main()
{
std::vector<vpPoint> vec_p;
p.set_x(1); p.set_y(1); // coordinates in meters in the image plane (vertex 1)
vec_p.push_back(p); p.set_x(2); p.set_y(2); // coordinates in meters in the image plane (vertex 2)
obj.setType(vpMomentObject::DISCRETE); // Discrete mode.
obj.fromVector(vec_p); // Init the dense object with the polygon
vpMomentGravityCenter G; // declaration of gravity center
vpMomentCentered mc; // mc contains centered moments
G.linkTo(db); //add gravity center to database
mc.linkTo(db); //centered moments depend on gravity, add them to the
//database to grant access
G.update(obj); // specify the object for gravity center
mc.update(obj); // and for centered moments
G.compute(); // compute the moment
mc.compute(); //compute centered moments AFTER gravity center
return 0;
}
This class allows to register all vpMoments so they can access each other according to their dependen...
Class describing 2D gravity center moment.
Class for generic objects.
void linkTo(vpMomentDatabase &moments)
Definition: vpMoment.cpp:98
void update(vpMomentObject &object)
Definition: vpMoment.cpp:115
Class that defines a 3D point in the object frame and allows forward projection of a 3D point in the ...
Definition: vpPoint.h:77
void set_x(double x)
Set the point x coordinate in the image plane.
Definition: vpPoint.cpp:508
void set_y(double y)
Set the point y coordinate in the image plane.
Definition: vpPoint.cpp:510
Parameters
data_base: database of moment primitives.
Examples
mbot-apriltag-ibvs.cpp, servoBebop2.cpp, servoPixhawkDroneIBVS.cpp, and testMomentAlpha.cpp.

Definition at line 98 of file vpMoment.cpp.

References vpException::memoryAllocationError, and vpMoment::name().

Referenced by vpMomentCommon::getAlpha(), vpMomentCommon::getMu3(), vpMomentCommon::getSurface(), and vpMomentCommon::vpMomentCommon().

◆ name()

const char* vpMomentCentered::name ( ) const
inlinevirtual

Moment name.

Implements vpMoment.

Definition at line 87 of file vpMomentCentered.h.

◆ printDependencies()

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

Prints moments required for calculation of vpMomentCentered, which are

  1. Raw geometric moments (vpMomentObject) and
  2. Centre of gravity (vpMomentGravityCentered)

Reimplemented from vpMoment.

Definition at line 172 of file vpMomentCentered.cpp.

References vpMomentDatabase::get(), vpMoment::getMoments(), vpMoment::getObject(), vpMomentGravityCenter::getXg(), vpMomentGravityCenter::getYg(), vpException::notInitialized, and vpMomentObject::printWithIndices().

◆ printWithIndices()

void vpMomentCentered::printWithIndices ( std::ostream &  os) const

Print in a readable form which looks better than output from << operator

Definition at line 154 of file vpMomentCentered.cpp.

References get(), vpMoment::getObject(), and vpMomentObject::getOrder().

◆ set()

void vpMomentCentered::set ( unsigned int  i,
unsigned int  j,
double  value 
)
protected

To set the values of centred moments. Required when normalizing the moment values.

Parameters
i: first index of the 2D moment.
j: second index of the 2D moment.
value: value of the moment.

Definition at line 52 of file vpMomentCentered.cpp.

References vpException::badValue, vpMoment::getObject(), vpMomentObject::getOrder(), and vpMoment::values.

◆ update()

void vpMoment::update ( vpMomentObject moment_object)
inherited

Updates the moment with the current object. This does not compute any values.

Parameters
moment_object: object descriptor of the current camera vision.

Definition at line 115 of file vpMoment.cpp.

Friends And Related Function Documentation

◆ operator<<

VISP_EXPORT std::ostream& operator<< ( std::ostream &  os,
const vpMomentCentered v 
)
friend

Outputs the centered moment's values $\mu_{ij}$ to a stream presented as a matrix. The first line corresponds to $\mu_{0[0:order]}$, the second one to $\mu_{1[0:order]}$ Values in table corresponding to a higher order are marked with an "x" and not computed.

For example, if the maximal order is 3, the following values are provided:

u00 u10 u20 u30
u01 u11 u21 x
u02 u12 x x
u30 x x x

This output will be followed by an output with indexes as produced by printWithIndices() function

Definition at line 133 of file vpMomentCentered.cpp.

Member Data Documentation

◆ values