imaqSelectAnnulus
Usage
int imaqSelectAnnulus(const Image* image, Annulus* annulus, const ConstructROIOptions* options, int* okay);
Purpose
Displays the image in a modal window and allows the user to draw an annulus on it. After the user draws the annulus, the function hides the window.
Image Types Supported
IMAQ_IMAGE_U8, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX, IMAQ_IMAGE_RGB, IMAQ_IMAGE_HSL, IMAQ_IMAGE_RGB_U64
Parameters
|
Name
|
Type
|
Description
|
|---|---|---|
| image | const Image* | The image from which the user selects an annulus. |
| annulus | Annulus* | On return, this parameter specifies the coordinates of the annulus chosen by the user. If the user does not select an annulus, the function sets all of the elements of annulus to –1. This parameter is required and cannot be NULL. |
| options | const ConstructROIOptions* | Describes how a function presents the annulus constructor window. |
| okay | int* | On return, this parameter is TRUE if the user pressed the OK button to end the selection of an annulus. Otherwise, this parameter is FALSE. Set this parameter to NULL if you do not need this 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(). |
Parameter Discussion
options—Set options to NULL to use the default options, as follows:
| windowNumber | IMAQ_MODAL_DIALOG |
| windowTitle | "Select an Annulus" |
| type | IMAQ_PALETTE_GRAY |
| palette | NULL |
| numColors | 0 |