drawcuboid
Create customizable cuboidal ROI
Description
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.
Note
drawcuboid is a convenience function for creating a
Cuboid ROI object. If you create the ROI object directly, calling
Cuboid, you
must call the draw object function to enable interactive drawing of
the ROI. In contrast, the drawcuboid function creates the ROI object
and calls the draw object function for you. Whichever way you create
the ROI, you use object properties, object functions, and event notifications to
customize its appearance and behavior. For more information about using these
capabilities, see Tips.
roi = drawcuboid(___,Name,Value)
Examples
Create Cuboid ROI on Scatter Plot
Create a 3-D scatter plot and interactively define a cuboid ROI over the data.
Define vectors for 3-D scatter data.
[x,y,z] = sphere(16); X = [x(:)*.5 x(:)*.75 x(:)]; Y = [y(:)*.5 y(:)*.75 y(:)]; Z = [z(:)*.5 z(:)*.75 z(:)];
Specify the size and color of each marker.
S = repmat([1 .75 .5]*10,numel(x),1); C = repmat([1 2 3],numel(x),1);
Create a 3-D scatter plot. Use view to the change the angle of
the axes in the figure.
figure
hScatter = scatter3(X(:),Y(:),Z(:),S(:),C(:),'filled');
view(-60,60);
Begin placing a cuboid ROI on the axes. The ROI snaps to the nearest point defined by the scatter plot. Adjust the size of the cuboid during interactive placement by using the scroll wheel.
drawcuboid(hScatter);
Set Up Listener for Cuboid ROI Events
Define vectors for 3-D scattered data.
[x,y,z] = sphere(16); X = [x(:)*.5 x(:)*.75 x(:)]; Y = [y(:)*.5 y(:)*.75 y(:)]; Z = [z(:)*.5 z(:)*.75 z(:)];
Specify the size and color of each marker.
S = repmat([1 .75 .5]*10,numel(x),1); C = repmat([1 2 3],numel(x),1);
Create a 3-D scatter plot and use view to change the angle of the axes in the figure.
figure
hScatter = scatter3(X(:),Y(:),Z(:),S(:),C(:),'filled');
view(-60,60);Begin placing a cuboid in the axes that snaps to the nearest point from the scatter plot. Adjust the size of the cuboid during interactive placement by using the scroll wheel.
roi = drawcuboid(hScatter,'Color','r');
Set up listeners for ROI moving events. When you move it, the ROI sends notifications of these events and executes the callback function you specify.
addlistener(roi,'MovingROI',@allevents); addlistener(roi,'ROIMoved',@allevents);
The allevents callback function displays the previous position and the current position of the ROI.
function allevents(src,evt) evname = evt.EventName; switch(evname) case{'MovingROI'} disp(['ROI moving previous position: ' mat2str(evt.PreviousPosition)]); disp(['ROI moving current position: ' mat2str(evt.CurrentPosition)]); case{'ROIMoved'} disp(['ROI moved previous position: ' mat2str(evt.PreviousPosition)]); disp(['ROI moved current position: ' mat2str(evt.CurrentPosition)]); end end
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 Positionfield.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 deleteobject function.The
drawcuboidfunction returns aCuboidROI object. After creation, use these capabilities of the object to customize the appearance and behavior of the ROI.Object properties — ROI objects support properties that modify their appearance or behavior. For example, to change the color of the
roito yellow, set itsColorproperty,roi.Color = 'yellow'.Object functions — ROI objects support a set of object functions that operate on the ROIs. For example, if you want to pause the MATLAB command line after creating an ROI, call the
waitobject function.Event notifications — ROI objects can notify your code when certain events, such as being moved or clicked, happen to the ROI. To receive these notifications, use the
addlistenerobject function to set up listeners for specific events. In the listener, specify an event, such as'ROIMoved', and a callback function that executes when the event occurs. 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.
For an example of using event listeners with the
Cuboidobject, see Set Up Listener for Cuboid ROI Events. For more details about these capabilities, see theCuboidobject documentation.
Compatibility Considerations
See Also
Cuboid | drawassisted | drawcircle | drawcrosshair | drawellipse | drawfreehand | drawline | drawpoint | drawpolygon | drawpolyline | drawrectangle