IMAQ Set Overlay Properties VI

LabView NI Vision

IMAQ Set Overlay Properties VI

Owning Palette: OverlayInstalled With: NI Vision Development Module

Sets the transformation behavior properties for groups of overlays.

IMAQ Set Overlay Properties

cgenclasstagrefflat.gif

Image is a reference to the source image.

c1dstr.gif

Groups is an array of strings consisting of the overlay group names for which you want to set the properties.

c1dnclst.gif

Properties specifies the overlay properties for an overlay group.

cenum.gif

Property is the name of the overlay property. The following values are valid:

Scale (0)

Specifies the behavior of an overlay group when a scale operation is applied to an image.

Shift (1)

Specifies the behavior of an overlay group when a shift operation is applied to an image.

Rotate (2)

Specifies the behavior of an overlay group when a rotate operation is applied to an image.

Symmetry (3)

Specifies the behavior of an overlay group when a symmetry operation is applied to an image.

cenum.gif

Behavior is the behavior of the overlay property. The following values are valid:

Clear (0)

Sets the behavior of the overlay group to clear the current settings when an image is transformed.

Keep (1)

Sets the behavior of the overlay group to keep the current settings when an image is transformed.

Transform (2)

Sets the behavior of the overlay group to transform with the image.

cerrcodeclst.gif

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

igenclasstagrefflat.gif

Image Out is a reference to Image.

ierrcodeclst.gif

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.