set_compriseSetCompriseSetCompriseset_compriseT_set_comprise

HALCON ScriptCpp++.NETPythonC

Short description

set_compriseSetCompriseSetCompriseset_compriseT_set_comprise — Define the image matrix output clipping.

Warning

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

Signature

set_comprise( window WindowHandle, string Mode )void SetComprise( const HTuple& WindowHandle, const HTuple& Mode )static void HOperatorSet.SetComprise( HTuple windowHandle, HTuple mode )def set_comprise( window_handle: HHandle, mode: str ) -> None

Herror T_set_comprise( 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)

void HWindow.SetComprise( string mode )

Description

set_compriseSetComprise defines the image matrix output clipping. If Modemodemode 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 Modemodemode 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

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

WindowHandlewindowHandlewindow_handle (input_control) window → (handle)HTuple (HHandle)HWindow, HTuple (IntPtr)HHandleHtuple (handle)

Window handle.

Modemodemode (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Clipping mode for gray value output.

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

Combinations with other operators

Combinations

Possible predecessors

get_compriseGetComprise

Possible successors

disp_imageDispImage

See also

get_compriseGetComprise, disp_imageDispImage, disp_colorDispColor

Module

Foundation