drawcuboid
Create customizable cuboidal ROI
Description
The drawcuboid
function creates a Cuboid
object that
specifies the shape and position of a cuboidal region of interest (ROI). You can create the
ROI interactively by drawing the ROI over an image using the mouse, or programmatically by
using name-value arguments. You can also specify the initial appearance and behavior of the
ROI.
After you create the ROI, you can use object properties, object functions, and event notifications to customize the shape, position, appearance, and behavior of the ROI. For more information about using these capabilities, see Tips.
creates a roi
= drawcuboidCuboid
ROI object
and enables interactive drawing of a cuboidal region of interest (ROI) on the current
axes.
To draw the ROI, call the drawcuboid
function. The function draws a
cuboidal ROI, centered in the volume. Move the pointer onto the image. The cursor changes to
a fleur shape. Move the ROI anywhere on the image. To finish the ROI, click the mouse
button. For more information about using the ROI, including keyboard shortcuts and context
menu options, see Tips.
modifies the appearance of the ROI using one or more name-value arguments.roi
= drawcuboid(___,Name=Value
)
Examples
Input Arguments
Output Arguments
Tips
The ROI supports the following interactivity, including keyboard shortcuts.
Behavior Keyboard shortcut Fine-tune ROI size while drawing. Use the scroll wheel to make small changes to the size of the ROI while drawing. Stop drawing the ROI. Press Esc. The function returns a valid ROI object with an empty Position
field.Resize (reshape) the ROI. Position the pointer on one of the visible faces of the cuboid and click and drag the surface. You might have to rotate the cuboid to select a surface.
If you press the Shift, dragging the mouse moves the ROI but does not change any of the dimensions.
Move the ROI. Position the pointer on any of the visible surfaces of the ROI and click and drag while pressing Shift.
Position the pointer on any visible surface of the ROI, right-click, and select Lock Dimensions. Click and drag to move the ROI.
Delete the ROI. Position the pointer over the ROI and right-click to view its context menu. Select Delete Cuboid from the menu. You can also delete the ROI using the delete
object function.The
drawcuboid
function creates aCuboid
object. After you create the object, you can modify the shape, position, appearance, and behavior of the ROI by using these object capabilities.Capability Support Object properties ROI objects have properties that specify their shape, position, appearance, and behavior. After you create the ROI object, change properties using dot notation.
For example, to change the color of the
roi
to yellow, set itsColor
property:roi.Color = 'yellow'
Object functions ROI objects have object functions that operate on the ROIs. For example, if you want to pause the MATLAB command line after creating an ROI, use the wait
function.Event notifications ROI objects can notify your code when certain events occur, such as when the ROI is clicked or when the ROI is being moved. To receive event notifications, set up listeners. When the ROI notifies your application through the listener, it returns data specific to the event. For example, with the
ROIMoved
event, the ROI object returns its previous position and its current position. You can specify a callback function that executes when an event occurs.For an example of using event listeners with the
Cuboid
object, see Set Up Listener for Cuboid ROI Events.