drawline

Create customizable linear ROI

Syntax

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

Description

example

h = drawline begins interactive placement of a linear region-of-interest (ROI) on the current axes. The function returns a handle to an images.roi.Line 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 = drawline(ax) creates an instance of the ROI in the axes specified by ax.

h = drawline(___,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 linear ROI interactively, position the pointer where you want to start drawing and then click and drag to draw the line. Release the pointer to finish the line. To delete the line, position the pointer over the line, right-click, and select Delete Line 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('car1.jpg'))

Draw two linear ROIs on the image. Use the 'SelectedColor' name-value pair to specify the color of the ROI when selected.

h1 = drawline('SelectedColor','yellow');
h2 = drawline('SelectedColor','magenta');

To turn the first line yellow, select the ROI programatically. You can also select an ROI by clicking it with the mouse. Click the second ROI to turn it magenta.

h1.Selected = true;

Read an image into the workspace and display it.

I = imread('baby.jpg');
figure
imshow(I)

Draw a linear ROI over the image. Use the 'Position' name-value pair to specify the location and length of the linear ROI. Set the line to be striped red by specifying the 'StripeColor' name-value pair.

h = drawline('Position',[500 500;500 1500],'StripeColor','r');

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 = drawline('LineWidth',4);

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.

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.

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 ROI, specified as a 2-by-2 array of the form [x1 y1; x2 y2]. Each row specifies the respective end-point of the linear ROI. This value changes automatically when you draw or move the line.

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 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.

Output Arguments

collapse all

Linear ROI, returned as an images.roi.Line object.

Tips

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

    BehaviorKeyboard shortcut
    Make drawn line snap to 15 degree angles.Hold the Shift key while drawing.
    Stop drawing the ROI.Press Esc. The function returns a valid ROI object with an empty Position field.
    Resize the ROI.

    Position pointer over either endpoint and then click and drag to resize the ROI. Hold the Shift key while resizing to snap the line drawn at 15 degree angles.

    Move the ROI.Position the pointer over the ROI. The pointer changes to the fleur shape. Then click and drag the ROI.

Introduced in R2018b