imaqGetCalibrationInfo
Usage
int imaqGetCalibrationInfo(const Image* image, CalibrationUnit* unit, float* xDistance, float* yDistance);
Purpose
Returns the calibration information of an image. This function is obsolete. The replacement function is imaqGetCalibrationInfo2(), which incorporates the functionality of imaqGetCalibrationInfo() with the grid element of the CalibrationInfo structure.
 |
Note This function is obsolete. The replacement function is imaqGetCalibrationInfo2(), which incorporates the functionality of imaqGetCalibrationInfo() with the grid element of the CalibrationInfo structure. |
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 | const Image* | The image whose calibration information the function queries. |
| unit | CalibrationUnit* | On return, the unit of measure that you specified in imaqSetCalibrationInfo(). Set this parameter to NULL if you do not need the unit information. |
| xDistance | float* | On return, the distance between two adjacent pixels in the x-direction. This value is in the units specified in unit. Set this parameter to NULL if you do not need the x-distance information. |
| yDistance | float* | On return, the distance between two adjacent pixels in the y-direction. This value is in the units specified in unit. Set this parameter to NULL if you do not need the y-distance information. |
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(). |