drawfreehand

Create customizable freehand ROI

Description

example

h = drawfreehand creates a Freehand ROI object and enables interactive drawing of a circular region-of-interest (ROI) on the current axes.

To draw the ROI, position the pointer on the image. The cursor changes to a fleur shape. Click and drag to draw the line. To finish the ROI, release the mouse button. For more information about using the ROI, including keyboard shortcuts and context menu options, see Tips.

Note

drawfreehand is a convenience function for creating a Freehand ROI object. If you create the ROI object directly, calling Freehand, you must call the draw object function to enable interactive drawing of the ROI. In contrast, the drawfreehand 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 = drawfreehand(ax) creates the ROI in the axes specified by ax.

h = drawfreehand(___,Name,Value) modifies the appearance and behavior of the ROI using one or more name-value pairs. Unspecified name-value pairs are set to the default value.

Examples

collapse all

Read an image into the workspace and display it.

imshow(imread('yellowlily.jpg'))

Draw a freehand ROI.

h = drawfreehand;

Fill in the face of the freehand ROI and disable the ability to select the ROI. The ROI does not move when you click and drag the mouse.

h.FaceAlpha = 1;
h.FaceSelectable = false;

Read an image into the workspace.

I = imread('cameraman.tif');

Display the image.

imshow(I);

Draw a freehand ROI on the image.

roi = drawfreehand('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.

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 = drawfreehand('LineWidth',5);

Close the freehand ROI, specified as the comma-separated pair consisting of 'Closed' and the logical value true or false. If true (default), drawfreehand closes the ROI by connecting the last waypoint drawn to the first waypoint drawn.

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 the current axes limits (default).
'unlimited'The drawing area has no boundary and ROIs can be drawn or dragged to extend beyond the axes limits.
[x,y,w,h]The drawing area is restricted to a rectangle beginning at (x,y), with width w and height h.

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

ROI face can capture clicks, specified as the comma-separated pair consisting of 'FaceSelectable' and the value true or false. When true (default), the ROI face can capture clicks. When false, the ROI face cannot capture clicks.

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'The ROI is fully interactable (default).
'none'The ROI is not interactable, and no drag points are visible.
'translate'ROI can be translated (moved) within the drawing area but not reshaped.
'reshape'ROI can be reshaped within the drawing area but not translated.

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.

Control the freehand drawing style during interactive placement, specified as the comma-separated pair consisting of 'Multiclick' and the logical scalar true or false. When the value is false (default), a single click and drag gesture completes the freehand. When true, multiple click and drag gestures can be combined with straight edges to make a more complex freehand shape.

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 freehand ROI, specified as an n-by-2 array, [x1 y1; …; xn yn] where each row specifies the position of a vertex of the freehand ROI.

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]

Smooth edge of ROI during interactive placement, specified as the comma-separated pair consisting of 'Smoothing' and a non-negative scalar. The Freehand object uses the standard deviation of the Gaussian smoothing kernel to filter the x and y coordinates of the ROI. This parameter defines the filter size as in this equation: 2*ceil(2*Smoothing) + 1. You must set the parameter before drawing the ROI interactively. You can see the smoothing effect only after completing the drawing.

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.

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.

Control points to reshape the ROI, specified as the comma-separated pair consisting of 'Waypoints' and an n-by-1 logical vector, the same length as Position. Each element of the Waypoints vector indicates if the corresponding point in the Position array is a waypoint. Positions that are waypoints are set to true in Waypoints. Dragging a waypoint modifies the ROI between the specified waypoint and its immediate neighboring waypoints. If empty, drawfreehand automatically generates Waypoints at locations of increased curvature.

Output Arguments

collapse all

Freehand ROI, returned as an Freehand object.

Tips

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

    BehaviorKeyboard shortcut
    Cancel drawing the ROI.Press Esc. The function returns a valid ROI object with an empty Position field.
    Finish drawing (close) the ROI.

    Double-click, which adds a point at the pointer position and draws a line connecting this point to the first point drawn, closing the ROI.

    Right-click, which draws a line connecting the last point to the first point drawn.

    Position the pointer over the first point and click.

    Press Enter, which draws a line connecting the last point to the first point drawn.

    Resize (reshape) the ROI.

    Position pointer over a waypoint and then click and drag. No assistance (snapping to edges) is available in this mode.

    Add a waypoint.

    Position the pointer on an edge of the ROI, right-click, and select Add Waypoint. You can also position the pointer on an edge of the ROI and double-click.

    Remove a waypoint.

    Position the pointer on a waypoint, right-click, and select Remove Waypoint.

    Move the ROI.Position the pointer over the ROI. The pointer changes to the fleur shape. Click and drag to move the ROI.
    Delete an ROI.Position the pointer on the ROI (not on a vertex), right-click, and select Delete Freehand from the context menu. You can also delete the ROI programmatically using the delete object method.
  • The drawfreehand function returns a Freehand 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 Freehand object, see Set Up Listener for Freehand ROI Events. For more details about these capabilities, see the Freehand object documentation.

Introduced in R2018b