Circular region of interest
The Circle
object is a circular region-of-interest
(ROI).
To draw the ROI, position the cursor on the axes and click and drag to create the shape. To finish drawing, release the pointer. For more information about using this ROI, including keyboard shortcuts, see Tips.
To create a Circle
object, use the
images.roi.Circle
creation function. After creating the object, call
the draw
object
function to begin drawing. As a convenience, you can also use the drawcircle
function to create a Circle
ROI. The drawcircle
function creates the ROI object and automatically calls the draw
object
function.
creates an instance
of the roi
= images.roi.Circleimages.roi.Circle
class with default properties.
creates the ROI on the axes specified by roi
= images.roi.Circle(ax
)ax
.
sets properties using
name-value pairs. For example, roi
= images.roi.Circle(___,Name,Value
)images.roi.Circle('Color','y')
sets the
color of the Circle
object to yellow. You can specify multiple
name-value pairs. Enclose each property name in single quotes.
addlistener | Create event listener bound to event source |
beginDrawingFromPoint | Begin drawing ROI from specified point |
bringToFront | Bring ROI to front of Axes stacking order |
createMask | Create binary mask image from ROI |
draw | Begin drawing ROI interactively |
inROI | Query if points are located in ROI |
wait | Block MATLAB command line until ROI operation is finished |
The ROI supports the following interactivity, including keyboard shortcuts.
Behavior | Keyboard shortcut |
---|---|
Finish drawing the ROI. | Release the mouse cursor. |
Cancel drawing the ROI. | Press Esc. The function returns a valid ROI object with an
empty Position field. |
Resize (reshape) the ROI. | Position pointer over a vertex and then click and drag. |
Move the ROI. | Position the cursor anywhere inside the ROI, press and hold the mouse, and move the ROI over the image. |
Delete the ROI. | Position the cursor on the circle, right-click, and select
Delete Circle from the context menu. You can also
delete the ROI programmatically using the delete object
function. |
For information about using an ROI in an app created with App Designer, see Using ROIs in Apps Created with App Designer.
AssistedFreehand
| Crosshair
| Cuboid
| drawcircle
| Ellipse
| Freehand
| Line
| Point
| Polygon
| Polyline
| Rectangle