Cuboidal region of interest
The Cuboid
object is a cuboidal region-of-interest
(ROI).
To draw the ROI, position the cursor on the ROI and click and drag to move or change the size of the shape. To finish the ROI, release the mouse button. For more information about using this ROI, including keyboard shortcuts and a right-click context menu, see Tips.
To create a Cuboid
ROI, use the images.roi.Cuboid
creation function. After creating the object, call the draw
object
function to begin drawing. As a convenience, you can also use the drawcuboid
function to create a Cuboid
ROI. The drawcuboid
function creates the ROI object and automatically calls the draw
object
function.
creates a
roi
= images.roi.CuboidCuboid
ROI object with default properties.
creates a roi
= images.roi.Cuboid(ax
)Cuboid
ROI object on the axes specified by
ax
.
sets
properties using
name-value pairs. For example, roi
= images.roi.Cuboid(___,Name,Value
)images.roi.Cuboid('Color','y')
sets the
color of the Cuboid
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 |
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 |
---|---|
Cancel drawing the ROI. | Press Esc. The function returns a valid ROI object with an
empty Position field. |
Fine-tune size of ROI as you are drawing. | As you draw the ROI, use the scroll wheel to make small changes to its size. |
Resize (reshape) the ROI. | Position the pointer over a surface of the ROI that is visible from your point of view and then click and drag. |
Move the ROI. | Position the pointer over a surface of the ROI that is visible from your point of view. Press Shift as you click and drag to move the ROI. |
Delete the ROI. | Position the pointer over the ROI, right-click, and select
Delete Cuboid 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
| Circle
| Crosshair
| drawcuboid
| Ellipse
| Freehand
| Line
| Point
| Polygon
| Polyline
| Rectangle