IMAQ Resample VI

Download PDF

Updated2023-02-21
5 minute(s) read

Owning Palette: Image Manipulation
Requires: NI Vision Development Module

Resamples an image to a user-defined size. You can use this VI to display a reduced or enlarged image.

Supported Image Types

8-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale floating point grayscale 32-bit HSL

IMAQ Resample

X Resolution specifies the horizontal resolution of the image.

Y Resolution specifies the vertical resolution of the image.

Image Src is a reference to the source image.

Image Dst is a reference to the destination image.

Interpolation Type specifies the interpolation method used to resample the image. The default is Zero Order. The following options are valid:

Zero Order (0)	Rounds to the nearest integral pixel location
Bi-Linear (1)	Uses linear interpolation in both the x- and y-directions to compute the pixel location
Quadratic (2)	Uses the quadratic formula to compute the pixel location
Cubic Spline (3)	Uses cubic splines to compute the pixel location

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

	status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to process. The right and bottom values are exclusive and lie outside the region. The VI applies the operation to the entire image if Optional Rectangle is empty or not connected.

Image Dst Out is a reference to the destination image. If Image Dst is connected, Image Dst Out is the same as Image Dst. Otherwise, Image Dst Out refers to the image referenced by Image Src.

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.