imaqExtractFromRing
Usage
Image* imaqExtractFromRing(SESSION_ID sessionID, int imageToExtract, int* imageNumber);
Purpose
Extracts an image from a live acquisition. This function lets you lock an image out of a continuous loop for processing during a ring acquisition. To unlock the image, call imaqReleaseImage(). The acquisition pauses when the continuous loop reaches the image you locked out.
Image Types Supported
IMAQ_IMAGE_U8, IMAQ_IMAGE_I16, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL
Parameters
|
Name
|
Type
|
Description
|
|---|---|---|
| sessionID | SESSION_ID | A valid session ID. |
| imageToExtract | int | The cumulative buffer index of the image to extract. If another image has overwritten imageToExtract, the function returns the next available image. |
| imageNumber | int* | The cumulative buffer index of the extracted image. Set this parameter to NULL if you do not need this information. |
Return Value
| Type |
Description |
|---|---|
| Image* | On success, this function returns a pointer to the extracted image. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). Because the return value is a pointer to an image that you provided to imaqSetupRing(), you should not dispose of the image until the acquisition is finished. |