drawfreehand

Create customizable freehand ROI

Syntax

h = drawfreehand
h = drawfreehand(ax)
h = drawfreehand(___,Name,Value)

Description

example

h = drawfreehand begins interactive placement of a freehand region-of-interest (ROI) on the current axes. The function returns a handle to an images.roi.Freehand object. You can modify the ROI interactively using your mouse. The ROI object also supports a context menu that controls aspects of its appearance and behavior.

h = drawfreehand(ax) begins interactive placement of an 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.

To create a freehand ROI interactively, position the pointer on the axes and click and drag to draw the ROI shape. Release the pointer to close the shape. To delete a freehand ROI, position the pointer over the ROI, right-click, and select Delete Freehand from the context menu. For more information about interactive behaviors including keyboard shortcuts, see Tips.

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;

Input Arguments

collapse all

Parent axes of the ROI, specified as an axes object.

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: h = 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. This value is not available with the drawPoint function.
'reshape'ROI can be reshaped within the drawing area but not translated. This value is not available with the drawPoint function and the drawRectangle function.

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.

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 object. A UIAxes cannot be the parent of the ROI.

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 the edge of the freehand ROI using the standard deviation of the Gaussian smoothing kernel, specified as the comma-separated pair consisting of 'Smoothing' and a nonnegative scalar. The function uses this 'Smoothing' value to filter the x and y coordinates of the freehand ROI. The function defines the filter size as 2*ceil(2*Smoothing) + 1.

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 using the findobj function.

Context menu, specified as the comma-separated pair consisting of 'UIContextMenu' and a uicontextmenu object. Specify this name-value pair to display a custom context menu when you right-click on the ROI. You can create a custom context menu by using the uicontextmenu function and then configuring 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 an invisible 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 images.roi.Freehand object.

Tips

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

    BehaviorKeyboard shortcut
    Finish drawing (close) the ROI.

    Right-click.

    Position pointer over the first vertex and click.

    Press Enter.

    Stop drawing the ROI.Press Esc. The function returns a valid ROI object with an empty Position field.
    Add a new vertex (waypoint) to the ROI.

    Position the pointer on the edge of the ROI and double-click.

    Position the pointer on the edge of the ROI, right-click, choose Add Waypoint from the context menu.

    Remove a vertex (waypoint) from the ROI.

    Position the pointer on a vertex, right-click, choose Remove Waypoint from the context menu.

    Resize (reshape) the ROI.

    Position pointer over a vertex and then click and drag.

    Add a new vertex to the polygon and then click and drag.

    Move the ROI.Position the pointer on the ROI. The pointer changes to the fleur shape. Click and drag the ROI.

Introduced in R2018b