imaqSetCalibrationInfo
Usage
int imaqSetCalibrationInfo(Image* image, CalibrationUnit unit, float xDistance, float yDistance);
Purpose
Sets the physical calibration attributes of an image. This function is obsolete. The replacement function is imaqSetSimpleCalibration(), which incorporates the functionality of imaqSetCalibrationInfo() with the grid parameter.
![]() |
Note This function is obsolete. The replacement function is imaqSetSimpleCalibration(), which incorporates the functionality of imaqSetCalibrationInfo() with the grid parameter. |
Image Types Supported
IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL
Parameters
Name
|
Type
|
Description
|
---|---|---|
image | Image* | The image whose calibration information the function sets. |
unit | CalibrationUnit | The unit of measure that the function uses to calibrate the image. |
xDistance | float | The distance in the x direction between two adjacent pixels in units specified by unit. |
yDistance | float | The distance in the y direction between to adjacent pixels in units specified by unit. |
Return Value
Type |
Description |
---|---|
int | On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError(). |