Operator Reference

get_lutT_get_lutGetLutGetLutget_lut (Operator)

get_lutT_get_lutGetLutGetLutget_lut — Get current look-up-table (lut).

Signature

get_lut( : : WindowHandle : LookUpTable)

Herror T_get_lut(const Htuple WindowHandle, Htuple* LookUpTable)

void GetLut(const HTuple& WindowHandle, HTuple* LookUpTable)

HTuple HWindow::GetLut() const

static void HOperatorSet.GetLut(HTuple windowHandle, out HTuple lookUpTable)

HTuple HWindow.GetLut()

def get_lut(window_handle: HHandle) -> Sequence[Union[int, str]]

Description

get_lutget_lutGetLutGetLutget_lut returns the name or the values of the look-up-table (lut) of the window, currently used by disp_imagedisp_imageDispImageDispImagedisp_image (or indirectly by disp_regiondisp_regionDispRegionDispRegiondisp_region, etc.) for output. To set a look-up-table use set_lutset_lutSetLutSetLutset_lut. If the current table is a system table without any modification ( by set_fixset_fixSetFixSetFixset_fix ), the name of the table is returned. If it is a modified table, a table read from a file or a table for output with pseudo real colors, the RGB-values of the table are returned.

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.

LookUpTableLookUpTableLookUpTablelookUpTablelook_up_table (output_control)  string-array HTupleSequence[Union[int, str]]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Name of look-up-table or tuple of RGB-values.

Result

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

Possible Successors

set_lutset_lutSetLutSetLutset_lut

See also

set_lutset_lutSetLutSetLutset_lut

Module

Foundation