IMAQ Mask VI
- Updated2023-02-21
- 4 minute(s) read
Requires: NI Vision Development Module
Recopies the Image Src into the Image Dst. If a pixel value is 0 in the Image Mask, the corresponding pixel in Image Dst is set to 0.
Supported Image Types

![]() |
Image Src is a reference to the source image. |
||||||
![]() |
Image Mask is an 8-bit image that specifies the region of the image that will be copied. Only pixels in the Image Src image that correspond to a non-zero pixel in the mask image are copied. All other pixels are set to 0. |
||||||
![]() |
Image Dst is a reference to the destination image. |
||||||
![]() |
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.
|
||||||
![]() |
Image Dst 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. |
||||||
![]() |
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.
|
Examples
Refer to the following for an example of how to use this VI.
- LabVIEW\examples\Vision\Image Management\Image Mask.vi









