Table Of Contents

Replace Color Plane (G Dataflow)

Last Modified: October 25, 2017

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

connector_pane_image
datatype_icon

color mode

Number from 0 to 3 that defines the image color format to use for the operation.

Unsigned 64-bit RGB images support only a color mode of RGB.

Choose from the following values:

Name Value Description
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)

datatype_icon

image src

Reference to the source image.

This image is not necessary if the image dst and the three color planes are connected.

datatype_icon

image dst

Reference to the destination image.

datatype_icon

red/hue plane

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 node does not replace the first color plane.

datatype_icon

green/saturation plane

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 node does not replace the second color plane.

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

blue/luma/value/intensity plane

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 node does not replace the third color plane.

datatype_icon

image dst 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.

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