IMAQ ROIToMask VI

LabView NI Vision

IMAQ ROIToMask VI

Owning Palette: Region of InterestInstalled With: NI Vision Development Module

Transforms a region of interest into a mask.

Details Examples

IMAQ ROIToMask

cgenclasstagrefflat.gif

Image Model serves as a template for the destination image where the mask is placed. This can be any image type that NI Vision supports. Image takes the characteristics of Image Model (size and location of ROI) when Image Model is connected. However, the connection of Image Model is optional. When no Image Model is connected, the size of the image mask generated is limited to the bounding rectangle of the ROI Descriptor, which reduces the amount of memory used. The offset of the image mask generated

cgenclasstagrefflat.gif

Image is a reference to the destination image in which the mask is created.

ccclst.gif

ROI Descriptor is the descriptor that defines the region of interest.

c1di32.gif

Global Rectangle is the minimum rectangle required to contain all of the contours in the ROI.

c1dcclst.gif

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

cenum.gif

ID refers to whether the contour is the external or internal edge of an ROI. If the contour is external, all of the area inside it is considered part of the ROI. This VI draws the contours in the order that they are listed in the ROI Descriptor.

Tip  Internal contours do not become part of the mask. You can use internal contours to create non-mask regions inside external contours.
cu32.gif

Type is the shape type of the contour.

cnclst.gif

Coordinates are the coordinates that define 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.

ci32.gif

Filling Value (255) is the pixel value of the mask. All pixels inside the region of interest take this value. The default value is 255.

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.

ibool.gif

Coordinates out of space? returns TRUE if any ROI data is found outside the space associated with the Image Model.

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

You can use this VI in two ways. The simplest technique is to connect the input Image Model. In this case you can use the source image, in which the image ROI was drawn, as a template for the final destination image by connecting it to Image Model. The output image (Image Out) automatically acquires the size of the image and location of the ROI as found in the original source image.

However, you do not have to connect an Image Model. In this case, the ROI requires an offset that is determined automatically from the upper-left corner of the bounding rectangle described by the ROI. These offset values are automatically set to the image mask.

Examples

Refer to the following for an example that uses this VI.

  • LabVIEW\examples\Vision\2. Functions\Analysis\Histogram Example.vi