Archived: Frequently Asked Questions about Vision Module for LabVIEW NXG

NI does not actively maintain this document.

This content provides support for older products and technology, so you may notice outdated links or obsolete information about operating systems or other relevant products.


This document answers frequently asked questions about Vision Module for LabVIEW NXG.


NOTE: The final release of LabVIEW NXG was LabVIEW NXG 5.1 in 2021. LabVIEW NXG is not recommended for new Vision projects. For more information about the change in the LabVIEW NXG life cycle, refer to the announcement in the LabVIEW Forum.


LabVIEW NXG Application Software

Q: Where can I find the Vision Help documents for LabVIEW NXG?

A: You can find information and detailed help on Vision Module for LabVIEW NXG functions in the NI Vision Core Manual.

Q: Where can I find the Vision examples for LabVIEW NXG?

A: They are located in the Learning Tab of LabVIEW NXG under Analysis > Vision.

Q: What are the new vision features available in LabVIEW NXG?

A: There are a few new features: 

  • The Display Control has a new UI with GPU-optimized rendering. There is now transparency support for overlays  and a more intuitive region of interest (ROI) tool. ROI changes are now captured as events through the event structure.
  • The LabVIEW NXG Vision Development Module also features an improved API. Improvements include: reducing the number of VIs through using "Modes" (polymorphic VIs), consistent VI connector panes and a standardized icon layout. Modes can now also be chosen through the configuration pane.


Software Installation

Q: How do I install vision software for LabVIEW NXG?

A: Vision Development Module (VDM) and Vision Acquisition Software (VAS) are supported in LabVIEW NXG version 2.0 and later. You can install support for Vision through the NI Package Manager.

A few considerations: 

  • If you are using version 2018 SP1 or older, Vision Assistant will need to be separately installed through a WinMIF installer as the feed is not currently available in NI Package manager yet. Through the WinMIF Installer, support for LabVIEW NXG can be added.
  • In Vision Acquisition Software 18.0, NI-IMAQdx support through the NI Package Manager only installs the basic run-time. You can optionally add support for LabVIEW NXG 2.1, MAX configuration and the High-Performance GigE driver. 
  • As of 2018 SP1, .NET support is no longer included in the installation through NI Package Manager.  

Note: WinMIF installer is part of the latest NI Vision Development 2018 installer.

Note: There is currently no FPGA or Real-Time support since it is not yet available in LabVIEW NXG.  

For more information about the compatibility between VDM and LabVIEW NXG, check the readme for your version of VDM.

Vision Acquisition Software driver support

Q: Which hardware is supported in LabVIEW NXG with the Vision Acquisition Driver?

A: Only the NI-IMAQdx driver is supported in LabVIEW NXG. Below is a list of supported hardware: 

  • USB 3.0 Vision Cameras (U3V)
  • GigE Vision Cameras
  • DirectShow Cameras (USB 2.0, Ethernet)
  • IP Cameras
  • IIDC/DCAM (IEEE1394) Cameras
  • Camera Link Vision Cameras
  • Camera Link Frame Grabbers: PCIe-1427, PCIe-1433, PCIe-1437 and PXIe-1435
  • GigE Frame Grabbers

If you are currently using the NI-IMAQ driver and would like to port your application over to LabVIEW NXG, you can now migrate to the NI-IMAQdx driver if you are using the supported hardware and software. Refer to Converting a Camera Link Application from the NI-IMAQ API to the NI-IMAQdx API


Q: How do I configure my vision hardware in LabVIEW NXG?

A: In terms of configuring the connected cameras, VAS for LabVIEW NXG will follow the same user work flow for configuring devices in LabVIEW NXG that other groups are using. This will be done through the use of Soft Front Panel (SFP) configuration windows which will include the following features:

  • Image Viewer to display Image - This includes the viewer tools for zooming and providing image information (i.e. image size, image type, pixel value/cursor location, zoom factor, etc.)
  • Control Acquisition (Start/Stop) – Provides a method to control the acquisition and acquire images.
  • Hierarchy of Attributes to configure camera settings-  Access to all camera attributes using the hierarchy defined by the camera is important for full configuration capabilities of camera. Cameras use the GenICam standard to define the attributes and this requires a hierarchy to represent the relationship of attributes correctly.
  • Capture Image (i.e. save single image to disk)  – Provides a method to save acquired images to disk.
  • Save and load configuration of camera settings - Provides a way to save the configuration so it can be used in gvi. Provide a way to load camera settings. For this release, we will not use the LabVIEW NXG project tree to store/retrieve camera settings, but will continue to use camera files in the IMAQdx/Data folder.
  • System Designer allows you to view your cameras and frame grabbers and configure them.  

With this functionality, users will be able to detect, configure and troubleshoot their cameras from within the LabVIEW NXG environment without needing to switch to NI-MAX. However, NI-MAX will still be installed and will still be necessary for the following use cases:

  • Renaming cameras
  • Switching drivers for USB 3.0 cameras
  • Configuring camera files for Camera Link devices
  • Firewire cameras – VAS for LabVIEW NXG does not include support for Firewire cameras in system designer and the Camera SFP. Configuration can be done through NI-MAX and the cameras can then be accessed programmatically in LabVIEW NXG
  • CG Real-Time targets – LabVIEW NXG as there is no RT support in this release


Migrating VDM applications to LabVIEW NXG

Q: What are some caveats of migrating?

A: The final release of LabVIEW NXG was LabVIEW NXG 5.1 in 2021. LabVIEW NXG is not recommended for new Vision projects.

For those continuing to work with older Vision projects within LabVIEW NXG, there are some considers with the Vision API.

  • When using the LabVIEW NXG Conversion Utility, a few VIs will return a broken run arrow (change of functionality or different input/outputs) when converted. These changes were made to improve the API. The customer will need to make small modifications to get the VI running. 
  • Some VIs in LabVIEW NXG will have different datatypes for their input or outputs. To align with other LabVIEW APIs, a few Vision VIs will now either return or take an array of bytes instead of a string. Example: Setup Match Geometric Pattern and Match Geometric Pattern setup data is now an array of bytes instead of a string.  
  • Some VIs will have different names in LabVIEW and LabVIEW NXG. To facilitate the migration process for customers, we have implemented a search functionality that will allow you to find the equivalent VI in LabVIEW NXG by entering the name of the VI used in LabVIEW. 
  • A few property and invoke nodes are not supported in LabVIEW NXG. 
  • The NI-IMAQ driver is not supported natively. Customers will first have to migrate to NI-IMAQdx in LabVIEW and will then be able to use the LabVIEW NXG Conversion Utility. For a guide on how to migrate from NI-IMAQ to NI-IMAQdx, please refer to Converting a Camera Link Application from the NI-IMAQ API to the NI-IMAQdx API.
  • Vision Acquisition and Vision Assistant Express VIs are not supported in LabVIEW NXG. Vision Assistant Code Generation is supported in LabVIEW NXG 2.1


Was this information helpful?