HALCON Reference Manual 10.0.2
Table of Contents / Graphics / Parameters ClassesClassesClasses | | | Operators

set_compriseset_compriseset_compriseSetCompriseSetComprise (Operator)

Name

set_compriseset_compriseset_compriseSetCompriseSetComprise — Define the image matrix output clipping.

Signature

set_comprise( : : WindowHandle, Mode : )

Herror set_comprise(const Hlong WindowHandle, const char* Mode)

Herror T_set_comprise(const Htuple WindowHandle, const Htuple Mode)

Herror set_comprise(const HTuple& WindowHandle, const HTuple& Mode)

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

void HOperatorSetX.SetComprise(
[in] VARIANT WindowHandle, [in] VARIANT Mode)

void HWindowX.SetComprise([in] BSTR Mode)

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

void HWindow.SetComprise(string mode)

Description

set_compriseset_compriseset_compriseSetCompriseSetComprise 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.

Parallelization

Parameters

WindowHandleWindowHandleWindowHandleWindowHandlewindowHandle (input_control)  window → HWindow, HTupleHTupleHWindowX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong)

Window_id.

ModeModeModeModemode (input_control)  string → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Clipping mode for gray value output.

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

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

Example (HDevelop)

open_window(0,0,-1,-1,'root','visible','',WindowHandle)
read_image(Image,'fabrik')
threshold(Image,Seg,100,255)
set_system('init_new_image','false')
sobel_amp(Image,Sob,'sum_abs',3)
disp_image(Sob,WindowHandle)
get_comprise(WindowHandle,Mode)
fwrite_string(FileHandle,['Current mode for gray values: ',Mode])
fnew_line(FileHandle)
set_comprise(WindowHandle,'image')
get_mbutton(WindowHandle,_,_,_)
disp_image(Sob,WindowHandle)
fwrite_string(FileHandle,['Current mode for gray values: image'])
fnew_line(FileHandle)

Example (C)

open_window(0,0,-1,-1,"root","visible","",&WindowHandle) ;
read_image(&Image,"fabrik") ;
threshold(Image,&Seg,100,255) ;
set_system("init_new_image","false") ;
sobel_amp(Image,&Sob,"sum_abs",3) ;
disp_image(Sob,WindowHandle) ;
get_comprise(&Mode) ;
fwrite_string(FileHandle,"Current mode for gray values: ") ;
fwrite_string(FileHandle,Mode) ;
fnew_line(FileHandle) ;
set_comprise(WindowHandle,"image") ;
get_mbutton(WindowHandle,NULL,NULL,NULL) ;
disp_image(Sob,WindowHandle) ;
fwrite_string(FileHandle,"Current mode for gray values: image") ;
fnew_line(FileHandle) ;

Example (HDevelop)

open_window(0,0,-1,-1,'root','visible','',WindowHandle)
read_image(Image,'fabrik')
threshold(Image,Seg,100,255)
set_system('init_new_image','false')
sobel_amp(Image,Sob,'sum_abs',3)
disp_image(Sob,WindowHandle)
get_comprise(WindowHandle,Mode)
fwrite_string(FileHandle,['Current mode for gray values: ',Mode])
fnew_line(FileHandle)
set_comprise(WindowHandle,'image')
get_mbutton(WindowHandle,_,_,_)
disp_image(Sob,WindowHandle)
fwrite_string(FileHandle,['Current mode for gray values: image'])
fnew_line(FileHandle)

Example (HDevelop)

open_window(0,0,-1,-1,'root','visible','',WindowHandle)
read_image(Image,'fabrik')
threshold(Image,Seg,100,255)
set_system('init_new_image','false')
sobel_amp(Image,Sob,'sum_abs',3)
disp_image(Sob,WindowHandle)
get_comprise(WindowHandle,Mode)
fwrite_string(FileHandle,['Current mode for gray values: ',Mode])
fnew_line(FileHandle)
set_comprise(WindowHandle,'image')
get_mbutton(WindowHandle,_,_,_)
disp_image(Sob,WindowHandle)
fwrite_string(FileHandle,['Current mode for gray values: image'])
fnew_line(FileHandle)

Example (HDevelop)

open_window(0,0,-1,-1,'root','visible','',WindowHandle)
read_image(Image,'fabrik')
threshold(Image,Seg,100,255)
set_system('init_new_image','false')
sobel_amp(Image,Sob,'sum_abs',3)
disp_image(Sob,WindowHandle)
get_comprise(WindowHandle,Mode)
fwrite_string(FileHandle,['Current mode for gray values: ',Mode])
fnew_line(FileHandle)
set_comprise(WindowHandle,'image')
get_mbutton(WindowHandle,_,_,_)
disp_image(Sob,WindowHandle)
fwrite_string(FileHandle,['Current mode for gray values: image'])
fnew_line(FileHandle)

Result

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

Possible Predecessors

get_compriseget_compriseget_compriseGetCompriseGetComprise

Possible Successors

disp_imagedisp_imagedisp_imageDispImageDispImage

See also

get_compriseget_compriseget_compriseGetCompriseGetComprise, disp_imagedisp_imagedisp_imageDispImageDispImage, disp_colordisp_colordisp_colorDispColorDispColor

Module

Foundation

Table of Contents / Graphics / Parameters ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH