IMAQ GetImageInfo VI

LabView NI Vision

IMAQ GetImageInfo VI

Owning Palette: Image ManagementInstalled With: NI Vision Development Module

Gives different characteristics of the image.

IMAQ GetImageInfo

cgenclasstagrefflat.gif

Image is a reference to the source image.

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.

iu32.gif

Image Type specifies the type of the image. Choose from the following values:

Grayscale (U8) (0)

8 bits per pixel (unsigned, standard monochrome)

Grayscale (16) (1)

16 bits per pixel (signed)

Grayscale (SGL) (2)

32 bits per pixel (floating point)

Complex (CSG) (3)

2 × 32 bits per pixel (floating point)

RGB (U32) (4)

32 bits per pixel (red, green, blue, alpha)

HSL (U32) (5)

32 bits per pixel (hue, saturation, luminance, alpha)

RGB (U64) (6)

64 bits per pixel (red, green, blue, alpha)

Grayscale (U16) (7)

16 bits per pixel (unsigned)

ienum.gif

Unit is the measuring unit associated with the image. Choose from the following values:

Undefined (0)

Units are undefined.

Angstrom (1)

Units are measured in angstroms.

Micrometer (2)

Units are measured in micrometers.

Millimeter (3)

Units are measured in millimeters.

Centimeter (4)

Units are measured in centimeters.

Meter (5)

Units are measured in meters.

Kilometer (6)

Units are measured in kilometers.

Microinch (7)

Units are measured in microinches.

Inch (8)

Units are measured in inches.

Feet (9)

Units are measured in feet.

Nautical miles (10)

Units are measured in nautical miles.

Standard miles (11)

Units are measured in standard miles.

Steps (12)

Units are measured in steps.

ii32.gif

X Resolution specifies the horizontal resolution of the image.

ii32.gif

Y Resolution specifies the vertical resolution of the image.

isgl.gif

X Step specifies the horizontal distance separating two adjacent pixels in the specified Unit.

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.

isgl.gif

Y Step specifies the vertical distance separating two adjacent pixels in the specified Unit.

istr.gif

Image Name is the name of the image.