IMAQ ColorHistogram VI

LabView NI Vision

IMAQ ColorHistogram VI

Owning Palette: Color ProcessingInstalled With: NI Vision Development Module

Calculates the histograms extracted from the three planes of an image. This VI can function in one of six modes corresponding to the six color models (RGB, HSL, HSV, HSI, CIE L*a*b*, or CIE XYZ). The IMAQ ColorHistograph VI, a variant of the IMAQ ColorHistogram VI, has the advantage that its output data is directly compatible with a LabVIEW graph.

IMAQ ColorHistogram

cu16.gif

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

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.

cgenclasstagrefflat.gif

Image Mask is an 8-bit image specifying the region in the image to use for the calculation. Only those pixels in the original image that correspond to an equivalent non-zero pixel in the mask image are used for the calculation. The entire image is used in the calculation if Image Mask is not connected.

ci32.gif

Number of Classes specifies the number of classes used to classify the pixels. The default value is 256.

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.

cnclst.gif

CIE Lab White Reference is the CIE X, Y, and Z values associated with white. The default values of this control work with RGB values of (255, 255, 255) as white.

icclst.gif

Red or Hue or X or L* Histogram Report is a cluster that returns the detailed results from a histogram calculated on a red or hue plane, depending on the Color Mode. This cluster is the same as the cluster used by the IMAQ Histogram VI. It contains the following elements:

i1du32.gif

histogram returns the histogram values in an array. The elements found in this array are the number of pixels per class. The nth class contains all pixel values belonging to the interval [(Starting Value + (n – 1) × Interval Width), (Starting Value + n × (Interval Width – 1))].

isgl.gif

Minimal Value returns the smallest pixel value used in calculating the histogram.

isgl.gif

Maximal Value returns the largest pixel value used in calculating the histogram.

isgl.gif

Starting Value is always equal to 0. It returns the smallest pixel value from the first class calculated in the histogram.

isgl.gif

Interval Width returns the length of each class.

isgl.gif

Mean Value returns the mean value of the pixels used in calculating the histogram.

isgl.gif

Standard Variation returns the standard deviation from the histogram. A higher value corresponds to a better distribution of the values in the histogram and the image.

ii32.gif

Area (pixels) returns the number of pixels used in the histogram calculation. This is influenced by the values specified in Interval Range and the contents of Image Mask.

icclst.gif

Green or Sat or Y or a* Histogram Report is a cluster that returns the detailed results from a histogram calculated on the green or saturation plane, depending on the Color Mode. This cluster is the same as the cluster used by the IMAQ Histogram VI. It contains the following elements:

i1du32.gif

histogram returns the histogram values in an array. The elements found in this array are the number of pixels per class. The nth class contains all pixel values belonging to the interval [(Starting Value + (n – 1) × Interval Width), (Starting Value + n × (Interval Width – 1))].

isgl.gif

Minimal Value returns the smallest pixel value used in calculating the histogram.

isgl.gif

Maximal Value returns the largest pixel value used in calculating the histogram.

isgl.gif

Starting Value is always equal to 0. It returns the smallest pixel value from the first class calculated in the histogram.

isgl.gif

Interval Width returns the length of each class.

isgl.gif

Mean Value returns the mean value of the pixels used in calculating the histogram.

isgl.gif

Standard Variation returns the standard deviation from the histogram. A higher value corresponds to a better distribution of the values in the histogram and the image.

ii32.gif

Area (pixels) returns the number of pixels used in the histogram calculation. This is influenced by the values specified in Interval Range and the contents of Image Mask.

icclst.gif

Blue or Luma or Val or Inten or Z or b* Histogram Report is a cluster that returns the detailed results from a histogram calculated on the blue, luminance, value, or intensity planes, depending on the Color Mode. This cluster is the same as the cluster used by the IMAQ Histogram VI. It contains the following elements:

i1du32.gif

histogram returns the histogram values in an array. The elements found in this array are the number of pixels per class. The nth class contains all pixel values belonging to the interval [(Starting Value + (n – 1) × Interval Width), (Starting Value + n × (Interval Width – 1))].

isgl.gif

Minimal Value returns the smallest pixel value used in calculating the histogram.

isgl.gif

Maximal Value returns the largest pixel value used in calculating the histogram.

isgl.gif

Starting Value is always equal to 0. It returns the smallest pixel value from the first class calculated in the histogram.

isgl.gif

Interval Width returns the length of each class.

isgl.gif

Mean Value returns the mean value of the pixels used in calculating the histogram.

isgl.gif

Standard Variation returns the standard deviation from the histogram. A higher value corresponds to a better distribution of the values in the histogram and the image.

ii32.gif

Area (pixels) returns the number of pixels used in the histogram calculation. This is influenced by the values specified in Interval Range and the contents of Image Mask.

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.