step

System object: vision.TextInserter
Package: vision

Draws the specified text onto input image

Syntax

TXTIMG = step(H,IMG)
TXTIMG = step(H,IMG)
TXTIMG = step(H,IMG,CELLIDX)
TXTIMG = step(H,IMG,VARS)
TXTIMG = step(H,IMG,COLOR)
TXTIMG = step(H,IMG,LOC)
TXTIMG = step(H,IMG,OPAC)
TXTIMG = step(H,IMG,CELLIDX,VARS,COLOR,LOC,OPAC)

Description

TXTIMG = step(H,IMG) draws the specified text onto input image IMG and returns the modified image Y . The image IMG can either be an M-by-N matrix of intensity values or an M-by-N-by-P array color video signal where P is the number of color planes.

TXTIMG = step(H,IMG) draws the specified text onto input image IMG and returns the modified image TXTIMG. The image IMG can either be an M-by-N matrix of intensity values or an M-by-N-by-P array color video signal where P is the number of color planes.

TXTIMG = step(H,IMG,CELLIDX) draws the text string selected by index, CELLIDX, when you set the Text property to a cell array of strings. For example, if you set the Text property to {'str1','str2'}, and the CELLIDX property to 1, the step method inserts the string 'str1' in the image. Values of CELLIDX outside of valid range result in no text drawn on the image.

TXTIMG = step(H,IMG,VARS) uses the data in VARS for variable substitution, when the Text property contains ANSI C printf-style format specifications (%d, %.2f, etc.). VARS is a scalar or a vector having length equal to the number of format specifiers in each element in the specified text string.

TXTIMG = step(H,IMG,COLOR) uses the given scalar or 3-element vector COLOR for the text intensity or color respectively, when you set the ColorSource property to Input port.

TXTIMG = step(H,IMG,LOC) places the text at the [x y] coordinates specified by LOC. This applies when you set the LocationSource property to Input port.

TXTIMG = step(H,IMG,OPAC) uses OPAC for the text opacity when you set the OpacitySource property to set to Input port.

TXTIMG = step(H,IMG,CELLIDX,VARS,COLOR,LOC,OPAC) draws the specified text onto image IMG using text string selection index CELLIDX , text variable substitution data VARS , intensity or color value COLOR at location LOC with opacity OPAC. You can use any combination or all possible inputs. Properties must be set appropriately.

    Note:   H specifies the System object™ on which to run this step method.

    The object performs an initialization the first time the step method is executed. This initialization locks nontunable properties and input specifications, such as dimensions, complexity, and data type of the input data. If you change a nontunable property or an input specification, the System object issues an error. To change nontunable properties or inputs, you must first call the release method to unlock the object.

Was this topic helpful?