Skip to content

get_hsiGetHsiGetHsiget_hsiT_get_hsi🔗

Short description🔗

get_hsiGetHsiGetHsiget_hsiT_get_hsi — Get the HSI coding of the current color.

Signature🔗

get_hsi( window WindowHandle, out integer Hue, out integer Saturation, out integer Intensity )void GetHsi( const HTuple& WindowHandle, HTuple* Hue, HTuple* Saturation, HTuple* Intensity )static void HOperatorSet.GetHsi( HTuple windowHandle, out HTuple hue, out HTuple saturation, out HTuple intensity )def get_hsi( window_handle: HHandle ) -> Tuple[Sequence[int], Sequence[int], Sequence[int]]

Herror T_get_hsi( const Htuple WindowHandle, Htuple* Hue, Htuple* Saturation, Htuple* Intensity )

HTuple HWindow::GetHsi( HTuple* Saturation, HTuple* Intensity ) const

HTuple HWindow.GetHsi( out HTuple saturation, out HTuple intensity )

Description🔗

get_hsiGetHsi returns the output color or gray values, respectively, for the window, described in Huehuehue, Saturationsaturationsaturation and Intensityintensityintensity. The values returned by get_hsiGetHsi can be set with set_hsiSetHsi.

Attention🔗

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

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Huehuehue (output_control) integer-array → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Hue (color value) of the current color.

Saturationsaturationsaturation (output_control) integer-array → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Saturation of the current color.

Intensityintensityintensity (output_control) integer-array → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Intensity of the current color.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

set_hsiSetHsi, set_rgbSetRgb, disp_imageDispImage

See also

set_hsiSetHsi, set_colorSetColor, set_rgbSetRgb, trans_to_rgbTransToRgb, trans_from_rgbTransFromRgb

Module🔗

Foundation