IMAQ Overlay Contour VI

Download PDF

Updated2023-02-21
6 minute(s) read

Owning Palette: Contour Analysis
Requires: NI Vision Development Module

Overlays a contour on an image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 64-bit complex 32-bit HSL

IMAQ Overlay Contour

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.

Contour Image is a reference to the image containing a contour.

Contour Points Settings specifies the settings for the contour points in the overlay.

Overlay? specifies whether to display the overlay on the image. The default is FALSE, which does not display the overlay on the image.

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.

Width specifies the width of the overlay in pixels.

Maintain Width? specifies whether you want the overlay measured in screen pixels or image pixels. Overlays measured in screen pixels maintain the same width as you zoom in on the image. Overlays measured in image pixels will scale with the image and appear to increase in width as you zoom in on the image. Set this value to TRUE (default) if you want the overlay measured in screen pixels. Set this value to FALSE if you want the overlay measured in image pixels.

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.

Contour Equation Settings specifies the settings for the contour equation in the overlay.

Overlay? specifies whether to display the overlay on the image. The default is FALSE, which does not display the overlay on the image.

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.

Width specifies the width of the overlay in pixels.

Maintain Width? specifies whether you want the overlay measured in screen pixels or image pixels. Overlays measured in screen pixels maintain the same width as you zoom in on the image. Overlays measured in image pixels will scale with the image and appear to increase in width as you zoom in on the image. Set this value to TRUE if you want the overlay measured in screen pixels. Set this value to FALSE (default) if you want the overlay measured in image pixels.

Image Out is a reference to the destination image.

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.

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 an example that uses this VI.

LabVIEW\examples\Vision\Contour\Contour Analysis.vi
LabVIEW\examples\Vision\Contour\Contour Defect Inspection.vi

NI Vision for LabVIEW

Table of Contents

IMAQ Overlay Contour VI

Supported Image Types

Details

Examples

Log in to get a better experience