get_compriseT_get_compriseGetCompriseGetCompriseget_comprise (Operator)

Name

get_compriseT_get_compriseGetCompriseGetCompriseget_comprise — Get the output treatment of an image matrix.

Warning

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

Signature

get_comprise( : : WindowHandle : Mode)

Description

get_compriseget_compriseGetCompriseGetCompriseGetCompriseget_comprise returns the output mode of gray values in the window WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle that is used by disp_imagedisp_imageDispImageDispImageDispImagedisp_image and disp_colordisp_colorDispColorDispColorDispColordisp_color. 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_compriseset_compriseSetCompriseSetCompriseSetCompriseset_comprise) and finally reset.

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

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → (handle)

Window handle.

ModeModeModeModemodemode (output_control) string → (string)

Display mode for images.

Result

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

Possible Successors

set_compriseset_compriseSetCompriseSetCompriseSetCompriseset_comprise, disp_imagedisp_imageDispImageDispImageDispImagedisp_image, disp_imagedisp_imageDispImageDispImageDispImagedisp_image

Module

Foundation

Operators