IMAQ ReplaceColorPlane VI

LabView NI Vision

IMAQ ReplaceColorPlane VI

Owning Palette: Color UtilitiesInstalled With: NI Vision Development Module

Replaces one or more image planes from a color image (RGB, HSL, HSV, or HSI). Only the planes connected at the input are replaced. If all three planes are connected, the input Image Src is not necessary, and only the Image Dst is used. The image is resized to the dimensions of the planes passed on input. Therefore, their sizes must be identical. If one or two planes are connected, the planes must have the same dimension as the source image.

IMAQ ReplaceColorPlane

cu16.gif

Color Mode defines the image color format to use for the operation. Choose from the following values:

Note  Unsigned 64-bit RGB images support only a Color Mode of RGB.
RGB (0)

(Default) Specifies the color format RGB (red, green, and blue)

HSL (1)

Specifies the color format HSI (hue, saturation, and luminance)

HSV (2)

Specifies the color format HSV (hue, saturation, and value)

HSI (3)

Specifies the color format HSI (hue, saturation, and intensity)

cgenclasstagrefflat.gif

Image Src is a reference to the source image. This image is not necessary if the Image Dst and the three color planes are connected.

cgenclasstagrefflat.gif

Image Dst is a reference to the destination image.

cgenclasstagrefflat.gif

Red or Hue Plane is the reference to the source image for the first color plane. This plane can be either the red plane (Color Mode RGB) or the hue plane (Color Mode HSL, HSV, or HSI). If Red or Hue Plane is connected, it must have as many bits per pixel as the replaced color plane. If Red or Hue Plane is not connected, the VI does not replace the first color plane.

cgenclasstagrefflat.gif

Green or Sat Plane is the reference to the source image for the second color plane. This plane can be either the green plane (Color Mode RGB) or the saturation plane (Color Mode HSL, HSV, or HSI). If Green or Saturation Plane is connected, it must have as many bits per pixel as the replaced color plane. If Green or Saturation Plane is not connected, the VI does not replace the second color plane.

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.

cgenclasstagrefflat.gif

Blue or Luma or Val or Inten Plane is the reference to the third color plane. This plane can be either the blue plane (Color Mode RGB), the luminance plane (Color Mode HSL), the value plane (Color Mode HSV) or the intensity plane (Color Mode HSI). If Blue or Luma or Val or Inten Plane is connected, it must have as many bits per pixel as the replaced color plane. If Blue or Luma or Val or Inten Plane is not connected, the VI does not replace the third color plane.

igenclasstagrefflat.gif

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

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.