# CircularROI¶

Bases: `Roi`

A 2D circular region of interest.

Parameters
xcfloat, optional

x coordinate of center.

ycfloat, optional

y coordinate of center.

Methods Summary

 `contains`(x, y) Test which of a set of (x, y) points fall within the region of interest. Returns True if the ROI is defined `move_to`(xdelta, ydelta) Translate the ROI to a center of (x, y) Reset the circular region `set_center`(x, y) Set the center of the circular region `set_radius`(radius) Set the radius of the circular region Returns vertices vx, vy of a polygon approximating the Roi, where each is an array of vertex coordinates in x and y. `transformed`([xfunc, yfunc]) A transformed version of the Roi

Methods Documentation

contains(x, y)[source]

Test which of a set of (x, y) points fall within the region of interest.

Parameters
xfloat or array-like

x coordinate(s) of point(s).

yfloat or array-like

y coordinate(s) of point(s).

Returns
insidebool or ~numpy.ndarray

An boolean iterable, where each element is True if the corresponding (x, y) tuple is inside the Roi.

Raises
UndefinedROI

If not defined.

defined()[source]

Returns True if the ROI is defined

get_center()[source]
move_to(xdelta, ydelta)[source]

Translate the ROI to a center of (x, y)

reset()[source]

Reset the circular region

set_center(x, y)[source]

Set the center of the circular region