get_hsi ( : : WindowHandle : Hue, Saturation, Intensity )

Get the HSI coding of the current color.

get_hsi returns the output color or grayvalues, respectively, for the window, described in Hue, Saturation and Intensity. get_hsi corresponds to the procedure get_pixel but returns the entries of the color lookup table instead of its indices. The values returned by get_hsi can be set with set_hsi.


Attention

The values returned by get_hsi may be inaccurate due to rounding errors. They do not necessarily match the values set with set_hsi exactly (colors are stored in RGB internally).


Parameters

WindowHandle (input_control)
window -> integer
Window_id.

Hue (output_control)
integer-array -> integer
Hue (color value) of the current color.

Saturation (output_control)
integer-array -> integer
Saturation of the current color.

Intensity (output_control)
integer-array -> integer
Intensity of the current color.


Result

get_hsi returns 2 (H_MSG_TRUE), if the window is valid. Otherwise an exception handling is raised.


Parallelization Information

get_hsi is reentrant and processed without parallelization.


Possible Successors

set_hsi, set_rgb, disp_image


See also

set_hsi, set_color, set_rgb, trans_to_rgb, trans_from_rgb


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH