imaqReplaceComplexPlane
Usage
int imaqReplaceComplexPlane(Image* dest, const Image* source, const Image* newValues, ComplexPlane plane);
Purpose
Replaces a plane of a complex image with the pixel values from a given image.
Image Types Supported
IMAQ_IMAGE_U8, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, IMAQ_IMAGE_COMPLEX
Parameters
Name
|
Type
|
Description
|
---|---|---|
dest | Image* | The destination image. |
source | const Image* | The image whose data the function modifies. |
newValues | const Image* | The image containing the replacement values. This image may be IMAQ_IMAGE_U8, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL, or IMAQ_IMAGE_COMPLEX. |
plane | ComplexPlane | The complex image plane to replace. Set this value to IMAQ_REAL or IMAQ_IMAGINARY. If source is a Complex image, then this parameter also selects which plane of the source image is used as the replacement. |
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(). |