drawcuboid

Create customizable cuboidal ROI

Description

example

roi = drawcuboid creates a Cuboid 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 an 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.

H = drawcuboid(ax) creates the ROI on the axes specified by ax instead of the current axes (gca).

roi = drawcuboid(S) creates the ROI on the Scatter object specified by S. During interactive placement, the cuboid snaps to the nearest point defined by the Scatter object.

roi = drawcuboid(___,Name,Value) modifies the appearance of the ROI using one or more name-value pairs.

Examples

collapse all

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);

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

collapse all

Parent axes of the ROI, specified as an axes object or a UIAxes object. For information about using an ROI in a UIAxes, including important limitations, see Using ROIs in Apps Created with App Designer.

Scatter plot, specified as a Scatter object. The parent of the Scatter object becomes the parent of the ROI.

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: roi = drawcuboid('Color','k','Label','My Cuboid');

ROI color, specified as the comma-separated pair consisting of 'Color' and a MATLAB® ColorSpec (Color Specification) value.

Example: 'green'

Example: 'g'

Example: [0 1 0]

ROI can be interactively deleted via a context menu, specified as the comma-separated pair consisting of 'Deletable' and a logical value of true or false. When the value is true (default), you can delete the ROI via the context menu. To disable this context menu item, set 'Deletable' to false. When the value is set to false, you can still delete the ROI by calling the delete function, specifying the handle to the ROI as the input.

Area of the axes in which you can interactively place the ROI, specified as the comma-separated pair consisting of 'DrawingArea' and one of the values in this table.

ValueDescription
'auto'

The drawing area is a superset of the current axes limits and a bounding box that surrounds the ROI (default).

'unlimited'The drawing area has no boundary and ROIs can be drawn or dragged to extend beyond the axes limits.
[x,y,z,w,h,d]The drawing area is restricted to a region beginning at (x,y,z), with width w, height h, and depth d.

Transparency of ROI edge, specified as the comma-separated pair consisting of 'EdgeAlpha' and a scalar in the range [0 1]. When set to 1, the ROI edge is fully opaque. When set to 0, the ROI edge is completely transparent.

Example: drawcuboid('EdgeAlpha',0.2)

Transparency of the ROI faces, specified as a numeric scalar value in the range [0 1]. When the value is 1, the ROI faces are fully opaque. When the value is 0, the ROI faces are completely transparent.

Transparency of ROI face directly underneath the mouse pointer, specified as the comma-separated pair consisting of 'FaceAlphaOnHover' and a scalar value in the range [0 1] or 'none' to indicate no change to face transparency. When set to 1, the face under the mouse pointer is fully opaque. When set to 0, the face is completely transparent.

Example: drawcuboid('FaceAlphaOnHover',1)

Color of the ROI face directly underneath the mouse pointer, specified as the comma-separated pair consisting of 'FaceColorOnHover' and a MATLABColorSpec (Color Specification) or 'none'. By default, the face color does not change on hover. (Hover means positioning the pointer over the surface of the cuboidal ROI.) When you are not hovering over a face of the ROI, the value of the ROI Color property determines the face color. The intensities must be in the range [0,1].

Example: drawcuboid('FaceColorOnHover','g')

Visibility of the ROI handle in the Children property of the parent, specified as the comma-separated pair consisting of 'HandleVisibility' and one of the values in this table.

ValueDescription
'on'The object handle is always visible (default).
'off'The object handle is hidden at all times.
'callback'The object handle is visible from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line.

Interactivity of the ROI, specified as the comma-separated pair consisting of 'InteractionsAllowed' and one of the values in this table.

ValueDescription
'all'ROI is fully interactable (default).
'none'ROI is not interactable, and no drag points are visible.
'translate'ROI can be translated (moved) within the drawing area but not reshaped.

ROI label, specified as the comma-separated pair consisting of 'Label' and a character vector or string. By default, this property is set to an empty array ('') and the ROI has no label.

Visibility of the ROI label, specified as the comma-separated pair consisting of 'LabelVisible' and one of these values.

ValueDescription
'on'Label is visible when the ROI is visible, and the Label property is nonempty (default).
'hover'

Label is visible only when the mouse hovers over the ROI.

'off'Label is not visible.

Width of the ROI edge, specified as the comma-separated pair consisting of 'LineWidth' and a positive numeric scalar in points. The default value is three times the number of points per screen pixel.

ROI parent, specified as the comma-separated pair consisting of 'Parent' and an Axes or UIAxes object. For information about using an ROI in a UIAxes, including important limitations, see Using ROIs in Apps Created with App Designer.

Position of the cuboid, specified as the comma-separated pair consisting of 'Position' and a 1-by-6 array of the form [xmin, ymin, zmin, width, height, depth]. This property updates automatically when you draw or move the cuboid.

Ability of the cuboid to be rotated, specified as the comma-separated pair consisting of 'Rotatable' and one of the values in this table.

ValueDescription
'all'ROI is fully rotatable.
'x' ROI can only be rotated about the x axis
'y'ROI can only be rotated about the y axis.
'z'ROI can only be rotated about the z axis.
'none'ROI is not rotatable.

Angle of ROI rotation, specified as the comma-separated pair consisting of 'RotationAngle' and a 1-by-3 numeric array of rotation angles, measured in degrees. The rotation angles array is of the form [x_angle y_angle z_angle], measured about the x-, y-, and z-axis, respectively. Rotation is applied about the ROI centroid in this order: z, y, x.

The value of RotationAngle does not impact the values in Position. Position represents the cuboid before any rotation. When you rotate the cuboid, use Vertices to determine the location of the rotated ROI.

Ability of the scroll wheel to adjust the size of the ROI, specified as the comma-separated pair consisting of 'ScrollWheelDuringDraw' and one of the values in this table.

ValueDescription
'allresize'Scroll wheel impacts all ROI dimensions.
'xresize' Scroll wheel impacts only the x dimension.
'yresize' Scroll wheel impacts only the y dimension.
'zresize' Scroll wheel impacts only the z dimension.
'none'Scroll wheel has no effect.

Selection state of the ROI, specified as the comma-separated pair consisting of 'Selected' and true or false. You can also set this value interactively. For example, clicking the ROI selects it and sets this value to true. Similarly, if you Ctrl-click the ROI, deselects it and sets this value to false.

Color of the ROI when selected, specified as the comma-separated pair consisting of 'SelectedColor' and a MATLAB ColorSpec (Color Specification). If 'SelectedColor' is set to 'none', then the value of Color defines the color of the ROI for all states, selected or not.

Example: 'green'

Example: 'g'

Example: [0 1 0]

Color of the ROI stripe, specified as the comma-separated pair consisting of 'StripeColor' and a MATLAB ColorSpec (Color Specification) value. If you specify 'StripeColor', the ROI edge is striped. The striping consists of a combination of the value specified by 'Color' and this value.

Example: 'green'

Example: 'g'

Example: [0 1 0]

Tag to associate with the ROI, specified as the comma-separated pair consisting of 'Tag' and a character vector or string scalar. Use the tag value to find the ROI object in a hierarchy of objects by using the findobj function.

Context menu, specified as the comma-separated pair consisting of 'UIContextMenu' and a ContextMenu object creating using the uicontextmenu function. Specify this name-value pair to display a custom context menu when you right-click the ROI. To create a custom context menu, create a ContextMenu object, by using the uicontextmenu function, and then configure context menu properties.

Data to associate with the ROI, specified as the comma-separated pair consisting of 'UserData' and any MATLAB data. For example, you can specify a scalar, vector, matrix, cell array, string, character array, table, or structure. MATLAB does not use this data.

This property is read-only.

Locations of the corners of cuboidal ROI, specified as an 8-by-3 array. Each row is the x-, y-, and z-coordinate of a corner of the cuboidal ROI.

ROI visibility, specified as the comma-separated pair consisting of 'Visible' and one of the values in this table.

ValueDescription
'on'Specify this value to display the ROI (default).
'off'Specify this value to hide the ROI without deleting it. You still can access the properties of a hidden ROI.

Output Arguments

collapse all

Cuboidal ROI, returned as an Cuboid object.

Tips

  • The ROI supports the following interactivity, including keyboard shortcuts.

    BehaviorKeyboard 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 returns a Cuboid ROI 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 roi to yellow, set its Color property, 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 wait object 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 addlistener object 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 Cuboid object, see Set Up Listener for Cuboid ROI Events. For more details about these capabilities, see the Cuboid object documentation.

Introduced in R2019a