insertShape
Insert shapes in image or video
Description
uses
additional options specified by one or more RGB
= insertShape(___,Name,Value
)Name,Value
pair
arguments.
Examples
Insert Circle and Filled Shapes on an Image
Read the image.
I = imread('peppers.png');
Draw a circle with a border line width of 5.
RGB = insertShape(I,'circle',[150 280 35],'LineWidth',5);
Draw a filled triangle and a filled hexagon.
pos_triangle = [183 297 302 250 316 297]; pos_hexagon = [340 163 305 186 303 257 334 294 362 255 361 191]; RGB = insertShape(RGB,'FilledPolygon',{pos_triangle,pos_hexagon},... 'Color', {'white','green'},'Opacity',0.7);
Display the image.
imshow(RGB);
Input Arguments
I
— Input image
M-by-N-by-3 truecolor | M-by-N 2-D grayscale
image
Input image, specified in truecolor or 2-D grayscale.
Data Types: single
| double
| int16
| uint8
| uint16
shape
— Type of shape
'Rectangle'
| 'FilledRectangle'
| 'Line'
| 'Polygon'
| 'FilledPolygon'
| 'Circle'
| 'FilledCircle'
Type of shape, specified as a character vector. The vector can
be, 'Rectangle'
, 'FilledRectangle'
, 'Line'
, 'Polygon'
, 'FilledPolygon'
, 'Circle'
,
or 'FilledCircle'
.
Data Types: char
position
— Position of shape
matrix | vector | cell array
Position of shape, specified according to the type of shape, described in the table.
Shape | Position | Example |
---|---|---|
'Rectangle' 'FilledRectangle' | For one or more rectangles, specify M-by-4 matrix where each row specifies
a rectangle as .
| Two rectangles, M=2 |
| For one or more disconnected lines, specify an M-by-4 matrix, where each four-element vector, , describes a line with endpoints. The polyline always contains (L-1) number of segments because the first and last vertex points do not connect. | Two lines, M=2 |
For one or more polylines or polygons with the same number of vertices, specify an M-by-2L matrix, where each row is a vector, , of consecutive vertex locations, representing a polyline or a polygon with L number of vertices. | Two polygons with equal number of vertices, M=2, L=5
| |
For one or more polylines or polygons with unequal number of vertices, specify an M-by-1 cell array, where each cell contains an L-by-2 matrix of [x,y] vertices, or a 1-by-2L vector, , of consecutive vertex locations. The value of L can be different for each cell element. For example, | Two polygons with unequal number of vertices, M=2 | |
'Circle' 'FilledCircle' | An M-by-3 matrix, where each row is a vector
specifying a circle as .
The coordinates
represent the center of the circle.
|
|
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
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: 'Color'
,'yellow'
specifies
yellow for the shape color.
LineWidth
— Shape border line width
1
(default) | positive scalar integer
Shape border line width, specified in pixels, as a positive
scalar integer. This property only applies to the 'Rectangle'
, 'Line'
, 'Polygon'
,
or 'Circle'
shapes.
Data Types: uint8
| uint16
| int16
| double
| single
Color
— Shape color
'yellow'
(default) | character vector | cell array of character vectors | [R G B] vector | M-by-3 matrix
Shape color, specified as the comma-separated pair consisting
of 'Color
' and either a character vector, cell
array of character vector, or matrix. You can specify a different
color for each shape, or one color for all shapes.
To specify a color for each shape, set Color
to
a cell array of color character vectors or an M-by-3
matrix of M number of RGB (red, green, and blue)
color values.
To specify one color for all shapes, set Color
to
either a color character vector or an [R G B] vector. The [R G B]
vector contains the red, green, and blue values.
Supported colors: 'blue'
, 'green'
, 'red'
, 'cyan'
, 'magenta'
, 'black'
,'black'
,
and 'white'
.
Data Types: cell
| char
| uint8
| uint16
| int16
| double
| single
Opacity
— Opacity of filled shape
0.6 (default) | range of [0
1
]
Opacity of filled shape, specified as the comma-separated pair
consisting of 'Opacity
' and a scalar value in
the range [0 1]. The Opacity
property applies
for the FilledRectangle
, FilledPolygon
,
and FilledCircle
shapes.
Data Types: double
| single
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
SmoothEdges
— Smooth shape edges
true
(default) | false
Smooth shape edges, specified as the comma-separated pair consisting
of 'SmoothEdges
' and a logical value of true
or false
.
A true
value enables an anti-aliasing filter to
smooth shape edges. This value applies only to nonrectangular shapes.
Enabling anti-aliasing requires additional time to draw the shapes.
Data Types: logical
Output Arguments
RGB
— Output image
M-by-N-by-3 truecolor
Output image, returned as a truecolor image.
Extended Capabilities
C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.
'Color'
and'SmoothEdges'
must be compile-time constants.
Version History
Open Example
You have a modified version of this example. Do you want to open this example with your edits?
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)