NI Vision for LabVIEW

IMAQ Correction Learn Setup VI

  • Updated2023-02-21
  • 5 minute(s) read
Owning Palette: Calibration
Requires: NI Vision Development Module

Sets parameters used to correct the calibration in an image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 16-bit signed grayscale floating point grayscale

IMAQ Correction Learn Setup

ccclst.gif

Correction ROI Descriptor specifies the ROI to use when correcting the calibration in an image. The whole image is corrected if there is no user-defined ROI.

c1di32.gif

Global Rectangle contains the coordinates of the bounding rectangle.

c1di32.gif

Global Rectangle contains the coordinates of the bounding rectangle.

cgenclasstagrefflat.gif

Calibration Template Image is a reference to the image containing calibration information.

ccclst.gif

Correction Learn Setup contains information about how the image correction is performed.

cu32.gif

Corrected Image Scaling defines the aspect scaling to use when correcting an image.

Scale to Preserve Area (0)

The corrected image is scaled such that the features in the image have the same size as the input image.

Scale to Fit (1)

The corrected image is scaled to be the same size as the input image.

cu32.gif

Corrected Image Learn ROI specifies the ROI to use when correcting an image.

Full Image (0)

The whole image is always corrected, regardless of the user-defined or calibration-defined ROIs.

Calibration ROI (1)

The area defined by the Calibration ROI is corrected. The calibration ROI is computed by the algorithm and corresponds to the area of the calibration template containing dots.

ROI (2)

The area defined by ROI Descriptor is corrected.

ROI AND Calibration ROI (3)

The area defined by the intersection of the ROI and Calibration ROI is corrected.

ROI OR Calibration ROI (4)

The area defined by the union of the ROI and Calibration ROI is corrected.

cbool.gif

Learn Correction Table? is a Boolean input value. Set this input to TRUE if you want the correction table to be determined and stored. The correction table accelerates the process of correcting an image. It is useful if several images are going to be corrected.

cerrcodeclst.gif

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.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

cbool.gif

Apply Calibration Axis (True), when TRUE, instructs the IMAQ Correct Calibrated Image VI to take into account the orientation and Axis reference of the calibration axis when correcting the image. As a result, the corrected image might be rotated and/or flipped, based on the angle and axis reference. When set to FALSE, the IMAQ Correct Calibrated Image VI ignores the calibration axis, and the resulted corrected image will maintain the orientation of the calibrated image.

igenclasstagrefflat.gif

Calibration Template Image Out is the reference to the output image. This image contains the learned calibration information.

ierrcodeclst.gif

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.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Log in to get a better experience