get_compriseT_get_compriseGetCompriseGetCompriseget_comprise (Operator)

Name

get_compriseT_get_compriseGetCompriseGetCompriseget_comprise — Get the output treatment of an image matrix.

Warning

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

Signature

Description

get_compriseget_compriseGetCompriseGetCompriseget_comprise returns the output mode of gray values in the window WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle that is used by disp_imagedisp_imageDispImageDispImagedisp_image and disp_colordisp_colorDispColorDispColordisp_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_compriseSetCompriseSetCompriseset_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

Result

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

Possible Successors

set_compriseset_compriseSetCompriseSetCompriseset_comprise, disp_imagedisp_imageDispImageDispImagedisp_image, disp_imagedisp_imageDispImageDispImagedisp_image

See also

set_compriseset_compriseSetCompriseSetCompriseset_comprise, disp_imagedisp_imageDispImageDispImagedisp_image, disp_colordisp_colorDispColorDispColordisp_color

Module

Foundation