get_comprise ( : : WindowHandle : Mode )

Get the output treatment of an image matrix.

get_comprise returns the output mode of grayvalues in the window WindowHandle that is used by disp_image and disp_color. The output mode defines whether only the grayvalues 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_comprise) and finally reset.


Parameters

WindowHandle (input_control)
window -> integer
Window_id.

Mode (output_control)
string -> string
Display mode for images.


Result

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


Parallelization Information

get_comprise is reentrant and processed without parallelization.


Possible Successors

set_comprise, disp_image, disp_image


See also

set_comprise, disp_image, disp_color


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH