Table Of Contents

Get Set Image Bit Depth (G Dataflow)

Last Modified: October 24, 2017

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 Window Draw node, the Cast Image node, and the Write Image File node for more information.

connector_pane_image
datatype_icon

image in

Reference to the source image.

datatype_icon

bit depth in

New bit depth of image in. Use this input only when get/set? is TRUE. 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 data type. For color images, this parameter specifies the bit depth for each plane.

datatype_icon

get/set?

Boolean value that specifies whether to determine the bit depth of the image or modify the bit depth of the image.

True Set the bit depth of the image
False Get the bit depth of the image

Default: TRUE (Set)

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

image out

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.

datatype_icon

bit depth out

Bit depth of image in. Use this output only when get/set? is FALSE (Get).

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics