imaqComplexPlaneToArray

Usage

float* imaqComplexPlaneToArray(const Image* image, ComplexPlane plane, Rect rect, int* columns, int* rows);

Purpose

Extracts a plane from a complex image into a two-dimensional array.

Image Types Supported

IMAQ_IMAGE_COMPLEX

Parameters

Name	Type	Description
image	const Image*	The image whose plane of pixel values are to be placed into an array.
plane	ComplexPlane	The plane to extract.
rect	Rect	Specifies a rectangular region of the image to return. Set this parameter to IMAQ_NO_RECT to return the specified plane of the entire image.
columns	int*	On return, the number of columns in the returned array. Set this parameter to NULL if you do not need this information.
rows	int*	On return, the number of rows in the returned array. Set this parameter to NULL if you do not need this information.

Return Value

Type	Description
float*	On success, this function returns a two-dimensional array of values corresponding to the pixel values of the extracted plane. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). When you are finished with the array, dispose of it by calling imaqDispose().