IMAQ Image Bit Depth VI

LabView NI Vision

previous page next page

IMAQ Image Bit Depth VI

Owning Palette: Image ManagementInstalled With: NI Vision Development Module

Gives information regarding the bit depth of an image or modifies the bit depth of an image. The bit depth of an image determines how NI Vision displays the image, casts the image to another image type, and writes the image to a PNG file. Refer to the IMAQ WindDraw VI, the IMAQ Cast Image VI, and the IMAQ Write PNG File 2 VI for more information.

IMAQ Image Bit Depth

Image is a reference to the source image.

Bit Depth (0) specifies the new bit depth of Image. Use this input only when Get/Set Bit Depth? (Set) is TRUE (Set). The value must be from 8 to 15 for signed 16-bit images, from 8 to 16 for unsigned 16-bit images and 64-bit RGB images, or 0. A value of 0 indicates that NI Vision should use the entire range of the image datatype.

Note For color images, this parameter specifies the bit depth for each plane.

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.

Get/Set Bit Depth? (Set) specifies whether to determine the bit depth of the image or modify the bit depth of the image. The default is TRUE (Set).

Image 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.

Bit Depth returns the bit depth of Image. Use this output only when Get/Set Bit Depth? (Set) is FALSE (Get).

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.

previous page start next page