(Not recommended) Region-of-interest (ROI) abstract base class
imroi abstract class and its inherited classes are not
recommended. Use new ROI objects instead. For more information, see Compatibility Considerations.
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
imroi class is a
For information on class attributes, see Class Attributes.
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
Deletable — ROI can be deleted
true (default) |
ROI can be deleted, specified as
|Add new-position callback to ROI object|
|(Not recommended) Create mask within image|
|Get color used to draw ROI object|
|Return current position of ROI object|
|Return function handle to current position constraint function|
|Remove new-position callback from ROI object|
|(Not recommended) Resume execution of MATLAB command line|
|(Not recommended) Set color used to draw ROI object|
|Set ROI object to new position|
|Set position constraint function of ROI object|
|(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.
Version HistoryIntroduced in R2008a
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
objects to the new ROI objects, see ROI Migration.