#include <visp3/core/vpImageCircle.h>

Public Member Functions
	vpImageCircle ()

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

float	computeAngularCoverageInRoI (const vpRect &roi, const float &roundingTolerance=0.001f) const

float	computeArcLengthInRoI (const vpRect &roi, const float &roundingTolerance=0.001f) const

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 37 of file vpImageCircle.cpp.

◆ vpImageCircle() [2/2]

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

Constructor from a center and radius.

Definition at line 44 of file vpImageCircle.cpp.

Member Function Documentation

◆ computeAngularCoverageInRoI()

float vpImageCircle::computeAngularCoverageInRoI	(	const vpRect &	roi,
		const float &	roundingTolerance = `0.001f`
	)		const

Compute the angular coverage, in terms of radians, that is contained in the Region of Interest (RoI).

See also: computeArcLengthInRoI(), computeArcLengthInRoI(const vpRect &roi)

Parameters

[in]	roi	The rectangular RoI in which we want to know the number of pixels of the circle that are contained.
[in]	roundingTolerance	The tolerance on the angle when the angle is close to a negative multiple of 2 * M_PIf.

Returns: Returns angular coverage of a circle in a ROI as an angle value in radians. More precisely, it returns 2.f * M_PI for a circle that is fully visible in the RoI, or the sum of the angles of the arc(s) that is(are) visible in the RoI.

Definition at line 909 of file vpImageCircle.cpp.

References vpException::fatalError, vpImagePoint::get_u(), vpImagePoint::get_v(), vpRect::getHeight(), vpRect::getTopLeft(), vpRect::getWidth(), vpRect::isInside(), and vpMath::modulo().

Referenced by computeArcLengthInRoI().

◆ computeArcLengthInRoI()

float vpImageCircle::computeArcLengthInRoI	(	const vpRect &	roi,
		const float &	roundingTolerance = `0.001f`
	)		const

Compute the arc length, in terms of number of pixels, that is contained in the Region of Interest (RoI).

See also: computeAngularCoverageInRoI(), computeAngularCoverageInRoI(const vpRect &roi)

Parameters

[in]	roi	The rectangular RoI in which we want to know the number of pixels of the circle that are contained.
[in]	roundingTolerance	The tolerance on the angle when the angle is close to 2.f * M_PIf .

Returns: The number of pixels of the circle that are contained in the RoI.

Definition at line 1020 of file vpImageCircle.cpp.

References computeAngularCoverageInRoI().

◆ 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 1047 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 1052 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 1042 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 1036 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 1026 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 1031 of file vpImageCircle.cpp.