Skip to content

get_compriseGetCompriseGetCompriseget_compriseT_get_comprise🔗

Short description🔗

get_compriseGetCompriseGetCompriseget_compriseT_get_comprise — Get the output treatment of an image matrix.

Warning🔗

get_compriseGetComprise is obsolete and is only provided for reasons of backward compatibility.

Signature🔗

get_comprise( window WindowHandle, out string Mode )void GetComprise( const HTuple& WindowHandle, HTuple* Mode )static void HOperatorSet.GetComprise( HTuple windowHandle, out HTuple mode )def get_comprise( window_handle: HHandle ) -> str

Herror T_get_comprise( const Htuple WindowHandle, Htuple* Mode )

static HString HInfo::GetComprise( const HWindow& WindowHandle )

static string HInfo.GetComprise( HWindow windowHandle )

Description🔗

get_compriseGetComprise returns the output mode of gray values in the window WindowHandlewindowHandlewindow_handle that is used by disp_imageDispImage and disp_colorDispColor. The output mode defines whether only the gray values of objects are displayed or the whole image is displayed. The query is used for temporary mode settings, i.e., the current mode is queried, then overwritten with (set_compriseSetComprise) and finally reset.

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.

Modemodemode (output_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Display mode for images.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible successors

set_compriseSetComprise, disp_imageDispImage, disp_imageDispImage

See also

set_compriseSetComprise, disp_imageDispImage, disp_colorDispColor

Module🔗

Foundation