disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1T_disp_rectangle1

HALCON ScriptCpp++.NETPythonC

Short description

disp_rectangle1DispRectangle1DispRectangle1disp_rectangle1T_disp_rectangle1 — Display of rectangles aligned to the coordinate axes.

Signature

disp_rectangle1( window WindowHandle, rectangle.origin.y Row1, rectangle.origin.x Column1, rectangle.corner.y Row2, rectangle.corner.x Column2 )void DispRectangle1( const HTuple& WindowHandle, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2 )static void HOperatorSet.DispRectangle1( HTuple windowHandle, HTuple row1, HTuple column1, HTuple row2, HTuple column2 )def disp_rectangle1( window_handle: HHandle, row_1: MaybeSequence[Union[int, float]], column_1: MaybeSequence[Union[int, float]], row_2: MaybeSequence[Union[int, float]], column_2: MaybeSequence[Union[int, float]] ) -> None

Herror T_disp_rectangle1( const Htuple WindowHandle, const Htuple Row1, const Htuple Column1, const Htuple Row2, const Htuple Column2 )

void HWindow::DispRectangle1( const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2 ) const

void HWindow::DispRectangle1( double Row1, double Column1, double Row2, double Column2 ) const

void HWindow.DispRectangle1( HTuple row1, HTuple column1, HTuple row2, HTuple column2 )

void HWindow.DispRectangle1( double row1, double column1, double row2, double column2 )

Description

disp_rectangle1DispRectangle1 displays one or several rectangles in the output window. A rectangle is described by the upper left corner (Row1row1row_1,Column1column1column_1) and the lower right corner (Row2row2row_2,Column2column2column_2). If the given coordinates are not within the boundary of the window the rectangle is clipped accordingly. The operators used to control the display of regions (e.g., set_colorSetColor, set_graySetGray, set_drawSetDraw, set_line_widthSetLineWidth) can also be used with rectangles. Several rectangles can be displayed with one call by using tuple parameters.

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.

Row1row1row_1 (input_control) rectangle.origin.y(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Row index of the upper left corner.

Default: 1616
Suggested values: 0, 64, 128, 256, 5110, 64, 128, 256, 511
Value range: 0 ≤ Row1 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Column1column1column_1 (input_control) rectangle.origin.x(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Column index of the upper left corner.

Default: 1616
Suggested values: 0, 64, 128, 256, 5110, 64, 128, 256, 511
Value range: 0 ≤ Column1 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10

Row2row2row_2 (input_control) rectangle.corner.y(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Row index of the lower right corner.

Default: 4848
Suggested values: 0, 64, 128, 256, 5110, 64, 128, 256, 511
Value range: 0 ≤ Row2 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10
Restriction: Row2 >= Row1

Column2column2column_2 (input_control) rectangle.corner.x(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[int, float]]Htuple (double / Hlong)

Column index of the lower right corner.

Default: 8080
Suggested values: 0, 64, 128, 256, 5110, 64, 128, 256, 511
Value range: 0 ≤ Column2 ≤ 511 (lin)
Minimum increment: 1
Recommended increment: 10
Restriction: Column2 >= Column1

Example

(HDevelop)

set_color(WindowHandle,'green')
draw_region(MyRegion,WindowHandle)
smallest_rectangle1(MyRegion,R1,C1,R2,C2)
disp_rectangle1(WindowHandle,R1,C1,R2,C2)

Result

disp_rectangle1DispRectangle1 returns 2 (H_MSG_TRUE).

Combinations with other operators

Combinations

Possible predecessors

open_windowOpenWindow, set_rgbSetRgb, set_lutSetLut, set_hsiSetHsi, set_drawSetDraw, set_colorSetColor, set_coloredSetColored, set_line_widthSetLineWidth

Alternatives

disp_rectangle2DispRectangle2, gen_rectangle1GenRectangle1, disp_regionDispRegion, disp_lineDispLine, set_shapeSetShape

See also

open_windowOpenWindow, set_colorSetColor, set_drawSetDraw, set_line_widthSetLineWidth

Module

Foundation