Operator Reference

HALCON Operator Reference / Legacy / Graphics

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

set_compriseT_set_compriseSetCompriseSetCompriseset_comprise (Operator)

set_compriseT_set_compriseSetCompriseSetCompriseset_comprise — Define the image matrix output clipping.

Warning

set_compriseset_compriseSetCompriseSetCompriseset_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_compriseSetCompriseSetCompriseset_comprise defines the image matrix output clipping. If ModeModeModemodemode 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 ModeModeModemodemode 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

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

ModeModeModemodemode (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Clipping mode for gray value output.

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

List of values: 'image'"image""image""image""image", '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_compriseSetCompriseSetCompriseset_comprise returns 2 ( H_MSG_TRUE) if ModeModeModemodemode is correct and the window is valid. Otherwise an exception is raised.

Possible Predecessors

get_compriseget_compriseGetCompriseGetCompriseget_comprise

Possible Successors

disp_imagedisp_imageDispImageDispImagedisp_image

See also

get_compriseget_compriseGetCompriseGetCompriseget_comprise, disp_imagedisp_imageDispImageDispImagedisp_image, disp_colordisp_colorDispColorDispColordisp_color

Module

Foundation

---

ClassesClasses | | Operators