imaqMaskToROI

Usage

ROI* imaqMaskToROI(const Image* mask, int* withinLimit);

Purpose

Transforms a mask image into a region of interest (ROI) descriptor.

Image Types Supported

IMAQ_IMAGE_U8

Parameters

Name	Type	Description
mask	const Image*	The mask image that the function transforms into a ROI. This image must be an IMAQ_IMAGE_U8 image.
withinLimit	int*	On return, this parameter indicates whether the ROI is a true representation of the mask. If TRUE, the number of points is within the INT_MAX point limit. If FALSE, the number of points exceeds the INT_MAX point limit, and the ROI may not represent the mask completely. Set this parameter to NULL if you do not need this information.

Return Value

Type	Description
ROI*	On success, this function returns a pointer to the ROI descriptor. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). When you are finished with this descriptor, dispose of the pointer by calling imaqDispose().