Skip to content

set_shapeSetShapeSetShapeset_shapeT_set_shape🔗

Short description🔗

set_shapeSetShapeSetShapeset_shapeT_set_shape — Define the region output shape.

Signature🔗

set_shape( window WindowHandle, string Shape )void SetShape( const HTuple& WindowHandle, const HTuple& Shape )static void HOperatorSet.SetShape( HTuple windowHandle, HTuple shape )def set_shape( window_handle: HHandle, shape: str ) -> None

Herror T_set_shape( const Htuple WindowHandle, const Htuple Shape )

void HWindow::SetShape( const HString& Shape ) const

void HWindow::SetShape( const char* Shape ) const

void HWindow::SetShape( const wchar_t* Shape ) const (Windows only)

void HWindow.SetShape( string shape )

Description🔗

set_shapeSetShape defines the shape for region output. It is only valid for the window with the logical window number WindowHandlewindowHandlewindow_handle. The output shape is used by disp_regionDispRegion. The available shapes can be queried with query_shapeQueryShape.

Available modes:

  • 'original'"original": The shape is displayed unchanged. Nevertheless modifications via parameters like set_line_widthSetLineWidth can take place. This is also true for all other modes.

  • 'outer_circle'"outer_circle": Each region is displayed by the smallest surrounding circle. (See smallest_circleSmallestCircle.)

  • 'inner_circle'"inner_circle": Each region is displayed by the largest included circle. (See inner_circleInnerCircle.)

  • 'ellipse'"ellipse": Each region is displayed by an ellipse with the same moments and orientation (See elliptic_axisEllipticAxis.)

  • 'rectangle1'"rectangle1": Each region is displayed by the smallest surrounding rectangle parallel to the coordinate axes. (See smallest_rectangle1SmallestRectangle1.)

  • 'rectangle2'"rectangle2": Each region is displayed by the smallest surrounding rectangle. (See smallest_rectangle2SmallestRectangle2.)

  • 'convex'"convex": Each region is displayed by its convex hull (See convexityConvexity.)

  • 'icon'"icon": Each region is displayed by the icon set with set_iconSetIcon in the center of gravity.

Attention🔗

Caution is advised for gray value output operators with output parameter settings that use region output.

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.

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

Region output mode.

Default: 'original'"original"
List of values: 'convex', 'ellipse', 'icon', 'inner_circle', 'original', 'outer_circle', 'rectangle1', 'rectangle2'"convex", "ellipse", "icon", "inner_circle", "original", "outer_circle", "rectangle1", "rectangle2"

Example🔗

(HDevelop)

read_image(Image,'fabrik')
regiongrowing(Image,Seg,5,5,6,100)
set_colored(WindowHandle,12)
set_shape(WindowHandle,'rectangle2')
disp_region(Seg,WindowHandle)

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

set_iconSetIcon, query_shapeQueryShape, get_shapeGetShape

Possible successors

disp_regionDispRegion

See also

get_shapeGetShape, query_shapeQueryShape, disp_regionDispRegion

Module🔗

Foundation