Table Of Contents

Get Calibration Information (G Dataflow)

Last Modified: June 25, 2019

Returns calibration information associated with an image.

connector_pane_image
datatype_icon

reference image

Reference to the image containing calibration information.

datatype_icon

return error information

Boolean that returns the error map and error statistics.

TRUE Computes the error map and error statistics
FALSE No error map or statistics are returned

Default: False

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

user ROI descriptor

Output that defines the region specified at the time of calibration.

datatype_icon

global rectangle

Coordinates of the bounding rectangle.

datatype_icon

contours

Individual shapes that define an ROI.

datatype_icon

ID

Control specifying whether the contour is the external or internal edge of an ROI.

datatype_icon

type

Shape type of the contour.

datatype_icon

coordinates

Relative position of the contour.

datatype_icon

calibration ROI descriptor

ROI that corresponds to the region of the image where the calibration information is accurate.

datatype_icon

global rectangle

Coordinates of the bounding rectangle.

datatype_icon

contours

Individual shapes that define an ROI.

datatype_icon

ID

Control specifying whether the contour is the external or internal edge of an ROI.

datatype_icon

type

Shape type of the contour.

datatype_icon

coordinates

Relative position of the contour.

datatype_icon

calibrated image dup

Reference to the output image.

datatype_icon

calibration axis info

Information about the calibration axis.

datatype_icon

origin pixel

Origin of the reference coordinate system expressed in pixel units.

datatype_icon

angle relative to horizontal (deg)

Angle relative to the horizontal in degrees.

The horizontal is expressed by a row of circle centers.

datatype_icon

axis reference

Orientation of the axis.

datatype_icon

calibration learn setup

Information about the calibrated image.

datatype_icon

method

Type of calibration method used.

Name Value Description
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.

datatype_icon

distortion

Type of distortion found in the image.

Name Value Description
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.

datatype_icon

corrected image scaling

Aspect scaling used to correct the image.

Name Value Description
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.

datatype_icon

corrected image learn ROI

ROI used to correct the image.

Name Value Description
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.

datatype_icon

learn correction table?

Value set when the calibration was learned.

datatype_icon

grid descriptor

Scaling constants used to calibrate the image.

datatype_icon

x step

Horizontal distance between points in the calibration grid in real-world units.

datatype_icon

y step

Vertical distance between points in the calibration grid in real-world units.

datatype_icon

unit

Units of x step and y step.

datatype_icon

threshold range

Range of grayscale values in a grid image that represent the circles.

This is the threshold range for detecting the centers of the circles. lower value and upper value must be between 128 and 255.

datatype_icon

lower value

Lowest pixel value used during a manual threshold.

Default: 128

datatype_icon

upper value

Highest pixel value used during a manual threshold.

Default: 255

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
datatype_icon

error statistics

Error information about the calibrated image.

datatype_icon

mean error

Mean distance error in real-world units.

datatype_icon

maximum error

Maximum distance error in real-world units.

datatype_icon

standard deviation

Standard deviation of the distance errors in real-world units.

datatype_icon

% distortion

Distortion percentage as the average result produced by calculating the error divided by the distance from the optical axis for each grid point.

datatype_icon

error map

Output that returns the error map if determined by the Learn Calibration node.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics