Image Logging Controls

NI Vision Builder

previous page next page
Use Additional Tools

Image Logging Controls

The following controls are available on the property page for the step.

Control Name Description
Step Name Name to give the step.
Image Logging Table Lists information about the available images. The following information is available:
  • State—Name of the state where the step that produces the image is located.
  • Step that Created Image—Name of the step that produces the image.
  • File Path—File path to the location where the images will be saved.
  • Log Limit—Maximum number of images to log.
  • Format—File format for the saved image.
Enable Image Logging When enabled, saves the images produced by the step selected in the Image Logging Table.
Log Location Specifies the location of the computer where the images are saved. The following options are available:
  • Log to Local Drive—Images are saved to a local drive. This option is not available for NI Smart Cameras.
  • Log to FTP Server—Images are saved to an FTP server.
IP Address IP Address or network address (FTPServerName) of the FTP server where you want to save the images.
User Name Name to use to log onto the FTP server.
Password Password to use to log onto the FTP server.
Test Login Verifies that the specified User Name and Password successfully log on to the FTP Server specified by IP Address.
Folder Path The file path to the directory where you want to save the measurement results.
File Name Name of the image file. If Append Timestamp is selected, File Name is used as a prefix before the timestamp.
Append Timestamp When enabled, a timestamp is added to the end of the specified File Name.
Log as a Background Task When enabled, allows the image logging process to be performed as a background task to allow the inspection to continue while images are being logged to the specified FTP server.
File Format File format to save the image as. Vision Builder AI allows you to save images using the following formats:
  • BMP—Windows Bitmap.
  • TIFF—Tagged Image File Format.
  • JPEG—File Interchange Format.
  • JPEG2000—File Interchange Format. This format is not available for NI Smart Cameras.
  • PNG—Portable Network Graphics.

Refer to Image Options for a complete list of the options available for each file format.
Merge Overlay Combines the current overlay(s) and inspection image into one image. If Merge Overlay is not selected, overlay information is not preserved. If Merge Overlay is selected, the image is saved as a color image.
Compress BMP File Specifies whether or not to use compression when a BMP image is saved.
Use Lossless Compression Specifies whether or not to use lossless compression when the image is saved. Lossless is only available for images saved as JPEG2000 files.
Image Quality Specifies the quality of the saved image. Valid values range from 0 to 1000. Image Quality is only available for images saved as JPEG or PNG files.
Compression Ratio Specifies the amount of compression to use when the image is saved. Valid values range from 0 to 1000. Compression Ratio is only available for images saved as JPEG2000 files.
Log Image Specifies the images to log. The following options are available:
  • Log Image—The selected image in the Image Logging Table is saved when this step executes regardless of the current state of the inspection.
  • Log Image Only when Inspection Status Fails—The selected image in the Image Logging Table is saved when this step executes and the current state of the inspection is FAIL. Use the Set Inspection Status step to update the inspection status during an inspection.
Limit Number of Logged Images When enabled, restricts the total number of images logged by the currently selected step. The specified limit only applies to the current instance of the Image Logging step.
Max Number of Logged Images Specifies the maximum number of images that will be logged from the selected step.
previous page start next page