get_compriseget_compriseGetCompriseget_compriseGetCompriseGetComprise (Operator)

Name

get_compriseget_compriseGetCompriseget_compriseGetCompriseGetComprise — Get the output treatment of an image matrix.

Signature

Description

get_compriseget_compriseGetCompriseget_compriseGetCompriseGetComprise returns the output mode of gray values in the window WindowHandleWindowHandleWindowHandleWindowHandleWindowHandlewindowHandle that is used by disp_imagedisp_imageDispImagedisp_imageDispImageDispImage and disp_colordisp_colorDispColordisp_colorDispColorDispColor. 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_compriseSetCompriseset_compriseSetCompriseSetComprise) and finally reset.

Parallelization

• 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_compriseGetCompriseget_compriseGetCompriseGetComprise returns 2 (H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Possible Successors

set_compriseset_compriseSetCompriseset_compriseSetCompriseSetComprise, disp_imagedisp_imageDispImagedisp_imageDispImageDispImage, disp_imagedisp_imageDispImagedisp_imageDispImageDispImage

See also

set_compriseset_compriseSetCompriseset_compriseSetCompriseSetComprise, disp_imagedisp_imageDispImagedisp_imageDispImageDispImage, disp_colordisp_colorDispColordisp_colorDispColorDispColor

Module

Foundation