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

#include <visp3/core/vpImageCircle.h>

Public Member Functions

 vpImageCircle ()
 
 vpImageCircle (const vpImagePoint &center, const float &radius)
 
virtual ~vpImageCircle ()
 
vpImagePoint getCenter () const
 
float getRadius () const
 
vpRect getBBox () const
 
float get_n20 () const
 
float get_n02 () const
 
float get_n11 () const
 

Detailed Description

Class that defines a 2D circle in an image.

Examples
tutorial-draw-circle.cpp.

Definition at line 55 of file vpImageCircle.h.

Constructor & Destructor Documentation

◆ vpImageCircle() [1/2]

vpImageCircle::vpImageCircle ( )

Default constructor.

Definition at line 38 of file vpImageCircle.cpp.

◆ vpImageCircle() [2/2]

vpImageCircle::vpImageCircle ( const vpImagePoint center,
const float &  radius 
)

Constructor from a center and radius.

Definition at line 45 of file vpImageCircle.cpp.

◆ ~vpImageCircle()

vpImageCircle::~vpImageCircle ( )
virtual

Default destructor.

Definition at line 61 of file vpImageCircle.cpp.

Member Function Documentation

◆ get_n02()

float vpImageCircle::get_n02 ( ) const

Compute the normalized moment $n_{02}$ of the image (2D) circle.

Returns
The normalized moment $n_{02}$.

Definition at line 87 of file vpImageCircle.cpp.

◆ get_n11()

float vpImageCircle::get_n11 ( ) const

Compute the normalized moment $n_{11}$ of the image (2D) circle.

Returns
The normalized moment $n_{11}$.

Definition at line 92 of file vpImageCircle.cpp.

◆ get_n20()

float vpImageCircle::get_n20 ( ) const

Compute the normalized moment $n_{20}$ of the image (2D) circle.

Returns
The normalized moment $n_{20}$.

Definition at line 82 of file vpImageCircle.cpp.

◆ getBBox()

vpRect vpImageCircle::getBBox ( ) const

Compute the bounding box, in the image, of the image (2D) circle.

Returns
the 2D circle bounding box.

Definition at line 76 of file vpImageCircle.cpp.

◆ getCenter()

vpImagePoint vpImageCircle::getCenter ( ) const

Get the center of the image (2D) circle

Returns
The center of the image (2D) circle.

Definition at line 66 of file vpImageCircle.cpp.

Referenced by vpDisplay::displayCircle(), and vpImageDraw::drawCircle().

◆ getRadius()

float vpImageCircle::getRadius ( ) const

Get the radius of the image (2D) circle.

Returns
The radius of the image (2D) circle.

Definition at line 71 of file vpImageCircle.cpp.

Referenced by vpDisplay::displayCircle(), and vpImageDraw::drawCircle().