IMAQ ConstructROI VI

LabView NI Vision

IMAQ ConstructROI VI

Owning Palette: External DisplayInstalled With: NI Vision Development Module

Allows the user to specify a region of interest (ROI) on the image. IMAQ ConstructROI displays the image in the specified window and provides the set of tools defined to select an ROI. IMAQ ConstructROI also returns the ROI descriptor that corresponds to the ROI drawn on the image when you click OK in the constructor window.

IMAQ ConstructROI

cstr.gif

Prompt specifies a message string to display in the title bar of the window. Use this control to provide the user with instructions about selecting the object.

ci32.gif

Window Number (-1...15) specifies the window number to display the image The default value is –1. When you select -1, the IMAQ ConstructROI VI displays a modal dialog window centered on the screen. When you select a regular NI Vision window number (0-15), the VI displays the Image in the specified window and temporarily sets the NI Vision window to modal mode. When the user clicks OK or Cancel, the attributes of the window are reset to their initial values.

cgenclasstagrefflat.gif

Image is a reference to the source image to use in the constructor window.

c1du32.gif

Tools is an array of tools specifying which tools are available. The following tools are available:

Selection Tool (0)

Select an ROI in the image.

Point Tool (1)

Select a pixel in the image.

Line Tool (2)

Draw a line in the image.

Rectangle Tool (3)

Draw a rectangle or square in the image.

Oval Tool (4)

Draw an oval or circle in the image.

Polygon Tool (5)

Draw a polygon in the image.

Freehand Region Tool (6)

Draw a freehand region in the image.

Annulus Tool (7)

Draw an annulus in the image.

Zoom Tool (8)

Zoom in or out in an image.

Panning Tool (9)

Shift the view of the image.

Broken Line Tool (10)

Draw a broken line in the image.

Freehand Line Tool (11)

Draw a freehand line in the image.

Rotated Rectangle Tool (12)

Draw a rotated rectangle in the image.

ccclst.gif

ROI Descriptor In (None) is a descriptor of the ROI that appears initially on the ROI Constructor window. Use this input to specify an ROI that the user can modify by resizing or moving it.

c1di32.gif

Global Rectangle contains the coordinates of the bounding rectangle.

c1dcclst.gif

Contours are each of the individual shapes that define an ROI.

cenum.gif

ID refers to whether the contour is the external or internal edge of an ROI.

cu32.gif

Type is the shape type of the contour.

c1di32.gif

Coordinates indicates the relative position of the contour.

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.

c1dnclst.gif

Color Palette is used to apply a color palette to an image window. Color Palette is an array of clusters constructed by the user or supplied by the IMAQ GetPalette VI. This palette is composed of 256 elements for each of the three color planes (red, green, and blue).

A specific color is the result of applying a value between 0 and 255 to each of the three color planes (red, green, and blue). If the three planes have identical values, a gray level is obtained (0 specifies black and 255 specifies white). The color palette can be used only for 8-bit images.

cu8.gif

Red is the value of the red color plane.

cu8.gif

Green is the value of the green color plane.

cu8.gif

Blue is the value of the blue color plane.

igenclasstagrefflat.gif

Image Out (duplicate) is a reference to Image. This VI does not modify the image connected to the Image input.

icclst.gif

ROI Descriptor Out returns the ROI descriptor created with the constructor window.

i1di32.gif

Global Rectangle contains the coordinates of the bounding rectangle.

i1dcclst.gif

Contours are each of the individual shapes that define an ROI.

ienum.gif

ID refers to whether the contour is the external or internal edge of an ROI.

iu32.gif

Type is the shape type of the contour.

i1di32.gif

Coordinates indicates the relative position of the contour.

ibool.gif

Cancel returns TRUE if the user clicks Cancel in the constructor window and returns FALSE if the user clicks OK.

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.