IMAQ ColorValueToInteger VI

LabView NI Vision

IMAQ ColorValueToInteger VI

Owning Palette: Color UtilitiesInstalled With: NI Vision Development Module

Converts clusters composed of three colors in mode (R, G, B), (H, S, L), (H, S, V), or (H, S, I) into colors encoded in the form of an unsigned 32-bit integer. The elements of these clusters can contain single values, 1D arrays, 2D arrays, or a combination of the above.

IMAQ ColorValueToInteger

cu16.gif

Color Mode defines the image color format to use for the operation. The default is RGB, which specifies that the input and output values are the same. Choose from the following values:

RGB (0)

(Default) No change

HSL (1)

Convert to HSL

HSV (2)

Convert to HSV

HSI (3)

Convert to HSI

cnclst.gif

Color Value is a cluster containing the value the VI converts. The VI interprets the cluster as (R, G, B), (H, S, L), (H, S, V), or (H, S, I), depending on the Color Mode. The cluster is composed of the following elements:

cu8.gif

Red or Hue value is the first color plane value, depending on the Color Mode.

cu8.gif

Green or Sat value is the second color plane value, depending on the Color Mode.

cu8.gif

Blue or Luma or Val or Inten value is the third color plane value, depending on the Color Mode.

c1dnclst.gif

1D Color value array is a 1D array of clusters containing the color values.

cu8.gif

Red or Hue value is the first color plane value, depending on the Color Mode.

cu8.gif

Green or Sat value is the second color plane value, depending on the Color Mode.

cu8.gif

Blue or Luma or Val or Inten value is the third color plane value, depending on the Color Mode.

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.

c2dnclst.gif

2D Color value array is a 2D array of clusters containing the color values. The VI interprets the array of clusters as (R, G, B), (H, S, L), (H, S, V), or (H, S, I), depending on the value Color Mode. These clusters are the same type as Color Value.

cu8.gif

Red or Hue value is the first color plane value, depending on the Color Mode.

cu8.gif

Green or Sat value is the second color plane value, depending on the Color Mode.

cu8.gif

Blue or Luma or Val or Inten value is the third color plane value, depending on the Color Mode.

iu32.gif

U32 value receives the color value resulting from the input Color Value. This array is encoded as an unsigned 32-bit integer.

i1du32.gif

1D U32 array receives the color value resulting from the input 1D Color value array. This array is encoded as a 1D array of unsigned 32-bit integers.

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.

i2du32.gif

2D U32 array receives the color value resulting from the input 2D Color value array. This array is encoded as a 2D array of unsigned 32-bit integers.