IMAQ Overlay ROI VI

Group specifies the group to which you want to add the overlay information. If no name is specified, the overlay information is added to the default group.

Image is a reference to the source image.

ROI Descriptor is a descriptor that defines the region of interest to overlay on the image.

	Global Rectangle contains the coordinates of the bounding rectangle.
	Contours are each of the individual shapes that define an ROI. ID refers to whether the contour is the external or internal edge of an ROI. Type is the shape type of the contour. Coordinates indicates the relative position of the contour.

Point Symbol is a bitmap that describes the symbol to use for a point ROI. If not specified, the VI overlays a single point for a point ROI.

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.

	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.
	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.
	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.

Colors (Green) is an array of colors associated with each of the ROIs described in the ROI descriptor.

Note  The alpha color channel is not supported. Setting the color to transparent has the same effect as selecting black.

Image Out is a reference to the destination image. If Image Dst is connected, Image Dst Out is the same as Image Dst. Otherwise, Image Dst Out refers to the image referenced by Image Src.

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.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	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.
	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.