insertObjectMask

Insert masks in image or video stream

Since R2020b

Syntax

RGB = insertObjectMask(I,BW)

RGB = insertObjectMask(I,maskstack)

RGB = insertObjectMask(___,Name,Value)

Description

RGB = insertObjectMask(I,BW) inserts a mask BW into the specified image I and returns the result as a truecolor image RGB.

RGB = insertObjectMask(I,maskstack) inserts a set of masks maskstack into the specified image I and returns the result as a truecolor image RGB.

RGB = insertObjectMask(___,Name,Value) specifies options using one or more name-value pair arguments in addition to the input arguments in previous syntaxes.

Examples

Insert Masks with White Border to Differentiate Close Objects

Read an image into the workspace.

I = imread('visionteam1.jpg');

Load a stack of binary masks.

load('visionteam1Maskstack.mat')

Insert the masks into the image.

RGB = insertObjectMask(I,maskstack,'LineColor','white','LineWidth',2);

Display the image with the masks inserted.

figure
imshow(RGB)

Insert Masks with Unique Color for Each Mask

Read an image into the workspace.

I = imread('visionteam1.jpg');

Load a stack of binary mask images.

load('visionteam1Maskstack.mat');

Insert the masks into the image, specifying a unique color for each mask.

numMasks = size(maskstack,3);
RGB = insertObjectMask(I,maskstack,'Color',lines(numMasks));

Display the image with the inserted masks.

figure 
imshow(RGB)

Input Arguments

I — Input image

truecolor image | grayscale image

Input image, specified as a truecolor (RGB) image, m-by-n-by-3 array, or a grayscale image, m-by-n array.

Data Types: single | double | int16 | uint8 | uint16

BW — Input mask image

m-by-n logical matrix

Input mask image, specified as an m-by-n logical matrix.

Data Types: logical

maskstack — Stack of mask images

m-by-n-by-P logical array

Stack of mask images, specified as an m-by-n-by-P logical array, where P is the total number of masks in the stack.

maskstack has the same width and height as I.

Data Types: logical

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: RGB = insertObjectMask(I,maskstack, 'LineColor','white','LineWidth',2);

Color — Color of each mask

lines(1) (default) | RGB triplet | ColorSpec

Color of each mask, specified as the comma-separated pair consisting of 'Color' and one of these values:

• P-by-3 matrix of RGB triplets, where P is the total number of masks

• P-element vector of MATLAB^® ColorSpec names

• 1-by-3 RGB triplet or scalar MATLAB ColorSpec name, specifying the color to use for all masks

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | string

Opacity — Opacity of mask

0.6 (default) | scalar in the range [0 1]

Opacity of mask, specified as the comma separated pair consisting of 'Opacity' and a scalar value in the range [0 1]. The value 1 makes the mask completely opaque and the value 0 makes the mask completely transparent.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

LineColor — Color of mask borders

'auto' (default) | RGB triplet | ColorSpec

Color of mask borders, specified as the comma separated pair consisting of 'LineColor' and one of these values:

• 'auto' — 'LineColor' uses the same value or values as 'Color'.

• P-by-3 matrix of RGB triplets, where P is the total number of masks

• P-element vector of MATLAB ColorSpec names

• 1-by-3 RGB triplet or scalar MATLAB ColorSpec name, specifying the color to use for all masks

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | string

LineOpacity — Opacity of mask borders

1 (default) | 0

Opacity of the mask borders, specified as the comma-separated pair consisting of 'LineOpacity' and a scalar value in the range of [0 1].

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

LineWidth — Width of mask borders

1 (default) | positive scalar

Width of mask borders, specified as the comma-separated pair consisting of 'LineWidth' and a positive scalar. Specify 'LineWidth' in pixel units.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Output Arguments

RGB — Output image

truecolor image

Output image, returned as a truecolor image of same datatype as the input image, with the same m-by-n dimensions as I.

Tips

• When masks overlap and the same pixel is in more than one mask, maskstack(:,:,i) takes precedence over maskstack(:,:,j), where i < j.

• For better performance, set 'LineOpacity' to 0 to disable drawing the edges.

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

• The value of the 'LineWidth' parameter must be a compile-time constant.

• The values of the 'Color' and 'LineColor' parameters must be numeric. The MATLAB ColorSpec is not supported with code generation.

Version History

Introduced in R2020b