IMAQ GetFileInfo VI

LabView NI Vision

IMAQ GetFileInfo VI

Owning Palette: FilesInstalled With: NI Vision Development Module

Obtains information regarding the contents of the file. This information is supplied for standard file formats only: BMP, TIFF, JPEG, JPEG2000, PNG, or AIPD.

IMAQ GetFileInfo

cpath.gif

File Path is the complete pathname—including drive, directory, and filename—for the file to be examined. This path can be supplied by either the user or the File Dialog VI from LabVIEW.

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.

inclst.gif

Calibration is a cluster containing the following elements:

isgl.gif

X Step is the horizontal distance separating two adjacent pixels (in units specified by Unit).

isgl.gif

Y Step is the vertical distance separating two adjacent pixels (in units specified by Unit).

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.

istr.gif

File Type indicates the file type that is read: BMP, TIFF, JPEG, JPEG2000, PNG, or AIPD (internal file format).

ii32.gif

X Resolution specifies the horizontal resolution of the image.

ii32.gif

Y Resolution specifies the vertical resolution of the 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.

ii32.gif

File Data Type indicates the pixel size defined in the header of the file.

iu32.gif

Image Type specifies the type of image that best fits the File Data Type of the file. This output can have 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, standard monochrome)