IMAQ Get Calibration Info 3 VI

Download PDF

Updated2023-02-21
8 minute(s) read

Owning Palette: Calibration
Requires: NI Vision Development Module

Returns calibration information associated with an image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale floating point grayscale 32-bit HSL

IMAQ Get Calibration Info 3

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

Return Error Information (False), when TRUE, computes the error map and error statistics. The default is FALSE.

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.

	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.
	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.
	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.

Error Map returns the error map of the calibration template image.

User ROI Descriptor defines the region you specified at the time of calibration.

Global Rectangle contains the coordinates of the bounding rectangle.

Contours are each of the individual shapes that define an ROI.

	ID refers to whether the contour is the external or internal edge of an ROI.
	Type is the shape type of the contour.
	Coordinates indicates the relative position of the contour.

Calibration Template Image (duplicate) is the reference to the output image.

Error Statistics provides error information about the calibrated image.

	Mean Error indicates the mean distance error in real-world units.
	Maximum Error indicates the maximum distance error in real-world units.
	Standard Deviation indicates the standard deviation of the distance errors in real-world units.
	% Distortion indicates the distortion percentage. The percentage distortion statistic is the average result produced by calculating the error divided by the distance from the optical axis for each grid point.

Calibration Learn Setup contains information about the calibrated image.

Method returns the type of calibration method used.

Perspective (0)	Image contains perspective calibration information.
Microplane (1)	Image contains nonlinear calibration information.
Simple (2)	Image contains simple calibration information (no perspective or nonlinear information).
Corrected (3)	Image has been corrected and contains calibration unit and scaling factor.
None (4)	Image contains no calibration information.

Distortion returns the type of distortion found in the image.

None (-1)	Image does not contain distortion correction.
Polynomial (0)	Image was calibrated using a polynomial distortion model.
Division (1)	Image was calibrated using the division distortion model.

Corrected Image Scaling returns the aspect scaling used to correct the 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.

Corrected Image Learn ROI returns the ROI used to correct the 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.

Learn Correction Table? returns the value set when the calibration was learned.

Grid Descriptor returns scaling constants used to calibrate the image.

	X Step indicates the horizontal distance between points in the calibration grid, in real-world units.
	Y Step indicates the vertical distance between points in the calibration grid, in real-world units.
	Unit indicates the units of X Step and Y Step.

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.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	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.
	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.

Calibration ROI Descriptor returns an ROI that corresponds to the region of the image where the calibration information is accurate.

Global Rectangle contains the coordinates of the bounding rectangle.

Contours are each of the individual shapes that define an ROI.

	ID refers to whether the contour is the external or internal edge of an ROI.
	Type is the shape type of the contour.
	Coordinates indicates the relative position of the contour.

Calibration Axis Info returns information about the calibration axis.

	Origin Pixel returns the origin of the reference coordinate system, expressed in pixel units.
	Angle Relative to Horizontal (deg) returns the angle relative to the horizontal, in degrees. The horizontal is expressed by a row of circle centers.
	Axis Reference returns is the orientation of the axis.

Examples

Refer to the following for examples that use this VI.

LabVIEW\examples\Vision\Calibration\Calibration Models Comparison.vi

NI Vision for LabVIEW

Table of Contents

IMAQ Get Calibration Info 3 VI

Supported Image Types

Examples