Operator Reference

HALCON Operator Reference / Legacy / Graphics
ClassesClasses | | Operators

set_insertT_set_insertSetInsertSetInsertset_insert (Operator)

set_insertT_set_insertSetInsertSetInsertset_insert — Define the pixel output function.

Warning

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

Signature

set_insert( : : WindowHandle, Mode : )

Herror T_set_insert(const Htuple WindowHandle, const Htuple Mode)

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

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

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

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

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

void HWindow.SetInsert(string mode)

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

Description

set_insertset_insertSetInsertSetInsertset_insert defines the function, with which pixels are displayed in the output window. It is e.g., possible for a pixel to overwrite the old value. In most of the cases there is a functional relationship between old and new values.

The definition value is only valid for the valid window. Output operators that honor ModeModeModemodemode are e.g., disp_regiondisp_regionDispRegionDispRegiondisp_region, disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon,disp_circledisp_circleDispCircleDispCircledisp_circle.

Possible display functions are:

'copy'"copy""copy""copy""copy":

overwrite displayed pixels

'xor'"xor""xor""xor""xor":

display old "xor" new pixels

'complement'"complement""complement""complement""complement":

complement displayed pixels

There may not be all functions available, depending on the physical display. However, “copy” is always available.

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*)

Name of the display function.

Default: 'copy' "copy" "copy" "copy" "copy"

List of values: 'complement'"complement""complement""complement""complement", 'copy'"copy""copy""copy""copy", 'xor'"xor""xor""xor""xor"

Result

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

Possible Predecessors

query_insertquery_insertQueryInsertQueryInsertquery_insert, get_insertget_insertGetInsertGetInsertget_insert

Possible Successors

disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

get_insertget_insertGetInsertGetInsertget_insert, query_insertquery_insertQueryInsertQueryInsertquery_insert

Module

Foundation

ClassesClasses | | Operators