set_compriseT_set_compriseSetCompriseSetCompriseset_comprise (Operator)

Name

set_compriseT_set_compriseSetCompriseSetCompriseset_comprise — Define the image matrix output clipping.

Warning

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

Signature

set_comprise( : : WindowHandle, Mode : )

Herror T_set_comprise(const Htuple WindowHandle, const Htuple Mode)

void SetComprise(const HTuple& WindowHandle, const HTuple& Mode)

void HWindow::SetComprise(const HString& Mode) const

void HWindow::SetComprise(const char* Mode) const

void HWindow::SetComprise(const wchar_t* Mode) const   (Windows only)

static void HOperatorSet.SetComprise(HTuple windowHandle, HTuple mode)

void HWindow.SetComprise(string mode)

def set_comprise(window_handle: HHandle, mode: str) -> None

Description

set_compriseset_compriseSetCompriseSetCompriseSetCompriseset_comprise defines the image matrix output clipping. If ModeModeModeModemodemode is set to 'object', only gray values belonging to the output object are displayed. If set to 'image', the whole image matrix is displayed. Default is 'object'.

Attention

If ModeModeModeModemodemode was set to 'image', undefined gray values may be displayed. Depending on the context they are black or can have random content. See the examples.

Execution Information

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

ModeModeModeModemodemode (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Clipping mode for gray value output.

Default value: 'object' "object" "object" "object" "object" "object"

List of values: 'image'"image""image""image""image""image", 'object'"object""object""object""object""object"

Example (HDevelop)

read_image(Image,'fabrik')
gen_circle (Circle, 200, 200, 100.5)
reduce_domain (Image, Circle, ImageReduced)
set_system('init_new_image','false')
sobel_amp(ImageReduced,SobelReduced,'sum_abs',3)
dev_display (SobelReduced)
get_comprise(WindowHandle,Mode)
set_comprise(WindowHandle,'image')
stop ()
dev_display (SobelReduced)

Result

set_compriseset_compriseSetCompriseSetCompriseSetCompriseset_comprise returns 2 (H_MSG_TRUE) if ModeModeModeModemodemode is correct and the window is valid. Otherwise an exception is raised.

Possible Predecessors

get_compriseget_compriseGetCompriseGetCompriseGetCompriseget_comprise

Possible Successors

disp_imagedisp_imageDispImageDispImageDispImagedisp_image

See also

get_compriseget_compriseGetCompriseGetCompriseGetCompriseget_comprise, disp_imagedisp_imageDispImageDispImageDispImagedisp_image, disp_colordisp_colorDispColorDispColorDispColordisp_color

Module

Foundation