imroi class

(Not recommended) Region-of-interest (ROI) base class

The imroi abstract class and its inherited classes are not recommended. Use new ROI objects instead. For more information, see Compatibility Considerations.

Description

The imroi class is an abstract base class that specifies the Image Processing Toolbox™ interface for working with regions of interest (ROIs). You can use classes that inherit from the imroi interface to create interactive ROIs over an image.

The imroi class is a handle class.

Class Attributes

Abstract

true

For information on class attributes, see Class Attributes.

Creation

The imroi class is abstract, and creating an instance of the imroi class is not allowed. To learn how to create an ROI object from a concrete subclass of imroi, see imellipse, imfreehand, imline, impoint, impoly, or imrect.

Properties

Deletable — ROI can be deleted

true (default) | false

ROI can be deleted, specified as true or false.

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

Methods

Public Methods

addNewPositionCallback	Add new-position callback to ROI object
createMask	Create mask within image
getColor	Get color used to draw ROI object
getPosition	Return current position of ROI object
getPositionConstraintFcn	Return function handle to current position constraint function
removeNewPositionCallback	Remove new-position callback from ROI object
resume	(Not recommended) Resume execution of MATLAB command line
setColor	(Not recommended) Set color used to draw ROI object
setConstrainedPosition	Set ROI object to new position
setPositionConstraintFcn	Set position constraint function of ROI object
wait	(Not recommended) Block MATLAB command line until ROI creation is finished

Specialized Operators and Functions

These methods specialize standard MATLAB^® operators and functions for objects in this class.

delete

Compatibility Considerations

imroi is not recommended

Not recommended starting in R2018b

Starting in R2018b, a new set of ROI objects replaces the existing set of ROI objects. The new objects provide more functional capabilities, such as face color transparency. The new classes also support events that you can use to respond to changes in your ROI such as moving or being clicked. Although there are no plans to remove the old ROI objects at this time, switch to the new ROIs to take advantage of the additional capabilities and flexibility. For more information on creating ROIs using the new ROI functions, see Create ROI Shapes.

For more information on updating code using instances of imroi objects to the new ROI objects, see ROI Migration.