imoverlay

Burn binary mask into 2-D image

Syntax

B = imoverlay(A,BW)

B = imoverlay(___,color)

Description

B = imoverlay(A,BW) fills the grayscale or RGB input image, A, with a solid color where the input binary mask, BW, is true.

B = imoverlay(___,color) lets you specify the color that imoverlay uses to fill the image. color is a valid MATLAB^® color specification.

Examples

Burn Binary Image into Grayscale Image

Read grayscale image into the workspace.

A = imread('cameraman.tif');

Read binary image into the workspace.

BW = imread('text.png');

Burn the binary image into the grayscale image, choosing the color to be used.

B = imoverlay(A,BW,'yellow');

Display the result.

figure
imshow(B)

Input Arguments

A — Input image

real, nonsparse 2-D matrix

Input image, specified as a real, nonsparse 2-D matrix.

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

BW — Mask image

2-D logical matrix

Mask image, specified 2-D logical matrix the same size as A.

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

color — Color used for the overlay

MATLAB color specification

Color used for the overlay, specified as a MATLAB color specification. For example, if you want to specify the color red, you could use any of the following specifications: 'red','r', or [1 0 0].

Output Arguments

B — Output image

2-D matrix

Output image, returned as a 2-D matrix of class uint8.

Extended Capabilities

C/C++ Code Generation

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

Usage notes and limitations:

• imoverlay supports the generation of C code (requires MATLAB Coder™). For more information, see Code Generation for Image Processing.

• When generating code, if you specify color as a character vector, it must be a compile-time constant.

GPU Code Generation

Generate CUDA® code for NVIDIA® GPUs using GPU Coder™.

Usage notes and limitations:

• When generating code, if you specify color as a character vector, it must be a compile-time constant.