GetCalibrationInformation Method

NI Vision for Visual Basic

GetCalibrationInformation Method

Syntax

CWIMAQVision.GetCalibrationInformation CalibratedImage, CalibrationReport

Return Type

Long

On success, this method returns 0. On failure, this method returns a negative number.

Purpose

Returns calibration information associated with an image.

Remarks

Use this method with image types U8, U16, I16, SGL, RGB32 and HSL32.

Use LearnCalibrationGrid, LearnCalibrationPoints, or SetSimpleCalibration to set the calibration information.

Parameters

CalibratedImage As CWIMAQImage

The calibrated image that determines the output calibration information.

CalibrationReport As CWIMAQCalibrationReport

On return, a report containing the calibration information.

Example

Dim report As New CWIMAQCalibrationReport
Dim simpleCalibrationOptions As New CWIMAQSimpleCalibrationOptions

' Calibrate the image in Viewer1
simpleCalibrationOptions.CalibrationAxisInfo.angle = 45
simpleCalibrationOptions.GridDescriptor.XStep = 10
simpleCalibrationOptions.GridDescriptor.YStep = 10
simpleCalibrationOptions.GridDescriptor.Unit = cwimaqCalUnitMeter

CWIMAQVision1.SetSimpleCalibration CWIMAQViewer1.Image, _
                                   simpleCalibrationOptions


' Get the calibration information from the image in Viewer1
CWIMAQVision1.GetCalibrationInformation CWIMAQViewer1.Image, report

See Also

LearnCalibrationGrid

LearnCalibrationPoints

SetSimpleCalibration