SetSimpleCalibration Method

NI Vision for Visual Basic

SetSimpleCalibration Method

Syntax

CWIMAQVision.SetSimpleCalibration ImageToCalibrate, SimpleCalibrationOptions

Return Type

Long

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

Purpose

Sets a simple calibration for an image or resets the real-world coordinate system in a calibrated image. When used to reset a coordinate system, if the correction table is still required, the table must be relearned. When the coordinate system angle is set to zero, you do not need to make a correction.

Remarks

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

Parameters

ImageToCalibrate As CWIMAQImage

The image to be calibrated.

SimpleCalibrationOptions As CWIMAQSimpleCalibrationOptions

Specifies the properties that define how to calibrate the image. If the image has been calibrated previously, using the CWIMAQVision.LearnCalibrationPoints or CWIMAQVision.LearnCalibrationGrid, this parameter is ignored and the previously defined properties are used.

Example

Simple Calibration Example