IMAQ Overlay Multiple Lines 2 VI
- Updated2023-02-21
- 5 minute(s) read
Requires: NI Vision Development Module
Overlays multiple lines, as either a polyline or a polygon, on an image.
Supported Image Types

![]() |
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. |
||||||
![]() |
Line End Points is an array of the point-coordinate clusters defining the ends of the lines to overlay.
|
||||||
![]() |
Drawing Mode (Frame) specifies whether to draw only the frame of the polygon or fill in the polygon. The default value is Frame. |
||||||
![]() |
Color is the color of the overlay.
|
||||||
![]() |
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.
|
||||||
![]() |
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. |
||||||
![]() |
Width specifies the width of the overlay in pixels. |
||||||
![]() |
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. |
||||||
![]() |
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.
|
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 Write Image And Vision Info File 2 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 examples that use this VI.
- LabVIEW\examples\Vision\Overlay Utilities\Overlay Landmark.vi
- LabVIEW\examples\Vision\Overlay Utilities\Overlay Line with Arrows Simple.vi
- LabVIEW\examples\Vision\Tracking\Object Tracking.vi













