Operator Reference

HALCON Operator Reference / Graphics / Parameters

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

get_hsiT_get_hsiGetHsiGetHsiget_hsi (Operator)

get_hsiT_get_hsiGetHsiGetHsiget_hsi — Get the HSI coding of the current color.

Signature

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

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

void GetHsi(const HTuple& WindowHandle, HTuple* Hue, HTuple* Saturation, HTuple* Intensity)

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

static void HOperatorSet.GetHsi(HTuple windowHandle, out HTuple hue, out HTuple saturation, out HTuple intensity)

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

def get_hsi(window_handle: HHandle) -> Tuple[Sequence[int], Sequence[int], Sequence[int]]

Description

get_hsiget_hsiGetHsiGetHsiget_hsi returns the output color or gray values, respectively, for the window, described in HueHueHuehuehue, SaturationSaturationSaturationsaturationsaturation and IntensityIntensityIntensityintensityintensity. The values returned by get_hsiget_hsiGetHsiGetHsiget_hsi can be set with set_hsiset_hsiSetHsiSetHsiset_hsi.

Attention

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

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

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

HueHueHuehuehue (output_control)  integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Hue (color value) of the current color.

SaturationSaturationSaturationsaturationsaturation (output_control)  integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Saturation of the current color.

IntensityIntensityIntensityintensityintensity (output_control)  integer-array → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Intensity of the current color.

Result

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

Possible Successors

set_hsiset_hsiSetHsiSetHsiset_hsi, set_rgbset_rgbSetRgbSetRgbset_rgb, disp_imagedisp_imageDispImageDispImagedisp_image

See also

set_hsiset_hsiSetHsiSetHsiset_hsi, set_colorset_colorSetColorSetColorset_color, set_rgbset_rgbSetRgbSetRgbset_rgb, trans_to_rgbtrans_to_rgbTransToRgbTransToRgbtrans_to_rgb, trans_from_rgbtrans_from_rgbTransFromRgbTransFromRgbtrans_from_rgb

Module

Foundation

---

ClassesClasses | | Operators