IMAQ ImageToArray VI

LabView NI Vision

IMAQ ImageToArray VI

Owning Palette: Pixel ManipulationInstalled With: NI Vision Development Module

Extracts (copies) the pixels from an image, or part of an image, into a LabVIEW 2D array. This array is encoded in 8 bits, 16 bits, or floating point, as determined by the type of input image.

Examples

IMAQ ImageToArray

cgenclasstagrefflat.gif

Image is a reference to the source image.

c1di32.gif

Optional Rectangle defines a four-element array that contains the left, top, right, and bottom coordinates of the region to extract. The operation applies to the entire image if the input is empty or not connected.

cerrcodeclst.gif

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.

cbool.gif

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.

ci32.gif

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.

cstr.gif

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.

i2du8.gif

Image Pixels (U8) returns the extracted pixel values into a 2D array. The first index corresponds to the vertical axis and the second index corresponds to the horizontal axis. The VI resizes Image Pixels to be the same size as Image or the size of Optional Rectangle. Use this output only when Image is an unsigned 8-bit image.

i2di16.gif

Image Pixels (I16) returns the extracted pixel values into a 2D array. The first index corresponds to the vertical axis and the second index corresponds to the horizontal axis. The VI resizes Image Pixels to be the same size as Image or the size of Optional Rectangle. Use this output only when Image is a signed 16-bit image.

i2dsgl.gif

Image Pixels (Float) returns the extracted pixel values into a 2D array. The first index corresponds to the vertical axis and the second index corresponds to the horizontal axis. The VI resizes Image Pixels to be the same size as Image or the size of Optional Rectangle. Use this output only when Image is a 32-bit floating-point image.

ierrcodeclst.gif

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.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

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.

istr.gif

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.

i2du16.gif

Image Pixels (U16) returns the extracted pixel values into a 2D array. The first index corresponds to the vertical axis and the second index corresponds to the horizontal axis. The VI resizes Image Pixels to be the same size as Image or the size of Optional Rectangle. Use this output only when Image is an unsigned 16-bit image.

Examples

Refer to the following for an example that uses this VI.

  • LabVIEW\examples\Vision\2. Functions\Image Management\ImageToArray Example.vi