imaqOverlayROI
Usage
int imaqOverlayROI(Image* image, const ROI* roi, PointSymbol symbol, const UserPointSymbol* userSymbol, const char* group);
Purpose
Overlays a region of interest onto an image.
Image Types Supported
IMAQ_IMAGE_U8, IMAQ_IMAGE_U16, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL, IMAQ_IMAGE_RGB_U64
Parameters
|
Name
|
Type
|
Description
|
|---|---|---|
| image | Image* | The image on which to overlay the region of interest. |
| roi | const ROI* | The region of interest to overlay on to the image. |
| symbol | PointSymbol | The symbol to represent a point contour in the overlay. |
| userSymbol | const UserPointSymbol* | If symbol is IMAQ_POINT_AS_USER_DEFINED, this parameter defines the symbol. Otherwise, the function ignores this parameter and you should set it to NULL. |
| group | const char* | The group to which you want to add the overlay. Set this parameter to NULL to add the overlay to the default group. |
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(). |