Transforms a region of interest into a mask.
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.gtype, which reduces the amount of memory used. The offset of the image mask generated is set to reflect the real position of the ROI.
Reference to the destination image in which the mask is created.
Descriptor that defines the region of interest.
Minimum rectangle required to contain all of the contours in the ROI.
Each of the individual shapes that define the ROI.
Contour that 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 node draws the contours in the order that they are listed in the ROI Descriptor.gtype.
Internal contours do not become part of the mask. You can use internal contours to create non-mask regions inside external contours.
Shape type of the contour.
Coordinates that define the contour.
Pixel value of the mask.
All pixels inside the region of interest take this value.
Default: 255
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
Default: No error
Pixel value of the background.
Default: 0
Reference to image in.
Error information.
The node produces this output according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
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.
Where This Node Can Run:
Desktop OS: Windows
FPGA: Not supported
Web Server: Not supported in VIs that run in a web application