ImageCircle¶

class ImageCircle(*args, **kwargs)¶

Bases: pybind11_object

Class that defines a 2D circle in an image.

Overloaded function.

__init__(self: visp._visp.core.ImageCircle) -> None

Default constructor.

__init__(self: visp._visp.core.ImageCircle, center: visp._visp.core.ImagePoint, radius: float) -> None

Constructor from a center and radius.

__init__(self: visp._visp.core.ImageCircle, vec: cv::Vec<float, 3>) -> None

Methods

`__init__`	Overloaded function.
`computeAngularCoverageInRoI`	param roi: The rectangular RoI in which we want to know the number of pixels of the circle that are contained.
`computeArcLengthInRoI`	param roi: The rectangular RoI in which we want to know the number of pixels of the circle that are contained.
`computePixelsInMask`	Count the number of pixels of the circle whose value in the mask is true.
`getBBox`	return: the 2D circle bounding box.
`getCenter`	return: The center of the image (2D) circle.
`getRadius`	return: The radius of the image (2D) circle.
`get_n02`	return: The normalized moment \(n_{02}\) .
`get_n11`	return: The normalized moment \(n_{11}\) .
`get_n20`	return: The normalized moment \(n_{20}\) .

Inherited Methods

Operators

`__doc__`
`__init__`	Overloaded function.
`__module__`

Attributes

`__annotations__`

__init__(*args, **kwargs)¶

Overloaded function.

__init__(self: visp._visp.core.ImageCircle) -> None

Default constructor.

__init__(self: visp._visp.core.ImageCircle, center: visp._visp.core.ImagePoint, radius: float) -> None

Constructor from a center and radius.

__init__(self: visp._visp.core.ImageCircle, vec: cv::Vec<float, 3>) -> None

computeAngularCoverageInRoI(self: visp._visp.core.ImageCircle, roi: visp._visp.core.Rect, roundingTolerance: float = 0.001f) → float¶

Parameters:

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

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.

computeArcLengthInRoI(self: visp._visp.core.ImageCircle, roi: visp._visp.core.Rect, roundingTolerance: float = 0.001f) → float¶

Parameters:

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

Returns:

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

computePixelsInMask(self: visp._visp.core.ImageCircle, mask: vpImage<bool>) → int¶

Count the number of pixels of the circle whose value in the mask is true.

Parameters:

mask: A mask where true indicates that a pixel must be taken into account and false that it must be ignored.

Returns:

unsigned int The number of pixels in the mask.

getBBox(self) → visp._visp.core.Rect¶

Returns:: the 2D circle bounding box.

getCenter(self) → visp._visp.core.ImagePoint¶

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

getRadius(self) → float¶

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

get_n02(self) → float¶

Returns:: The normalized moment \(n_{02}\) .

get_n11(self) → float¶

Returns:: The normalized moment \(n_{11}\) .

get_n20(self) → float¶

Returns:: The normalized moment \(n_{20}\) .