IMAQ Overlay Oval VI

LabView NI Vision

IMAQ Overlay Oval VI

Owning Palette: OverlayInstalled With: NI Vision Development Module

Overlays an oval on an image.

Details Examples

IMAQ Overlay Oval

cstr.gif

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.

cgenclasstagrefflat.gif

Image is a reference to the source image.

cnclst.gif

Bounding Rectangle is the coordinates of the bounding rectangle that define the oval along which the arc lies.

ci32.gif

Left is the value for the left side of the rectangle.

ci32.gif

Top is the value for the top of the rectangle.

ci32.gif

Right is the value for the right side of the rectangle.

ci32.gif

Bottom is the value for the bottom of the rectangle.

cu32.gif

Drawing Mode (Frame) specifies whether to draw only the frame of the oval or fill in the oval.

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.

cu32.gif

Color is the color of the overlay.

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

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.

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.

Details

Overlays are nondestructive, which means that they do not overwrite the underlying pixel values. You can save overlay information with an image by using the IMAQ Read Image And Vision Info VI. If you want to replace the underlying pixel values with the overlay values, use the IMAQ Merge Overlay VI.

Examples

Refer to the following for examples that use this VI.

  • LabVIEW\examples\Vision\2. Functions\Caliper\Edge Detection Example.llb

  • LabVIEW\examples\Vision\2. Functions\Pattern Matching\Pattern Matching Example.llb