set_shape (Operator)

Name

set_shape — Define the region output shape.

Synopsis

set_shape( : : WindowHandle, Shape : )

Description

set_shape defines the shape for region output. It is only valid for the window with the logical window number WindowHandle. The output shape is used by disp_region. The available shapes can be queried with query_shape.

Available modes:

  'original'
               The shape is displayed unchanged. Nevertheless
               modifications via parameters like set_line_width or
               set_line_approx can take place. This is also true for
               all other modes.
  'outer_circle'
               Each region is displayed by the smallest surrounding
               circle. (See smallest_circle.)
  'inner_circle'
               Each region is displayed by the largest included
               circle. (See inner_circle.)
  'ellipse'
               Each region is displayed by an ellipse with the same
               moments and orientation (See elliptic_axis.)
  'rectangle1'
               Each region is displayed by the smallest surrounding
               rectangle parallel to the coordinate axes. (See
               smallest_rectangle1.)
  'rectangle2'
               Each region is displayed by the smallest surrounding
               rectangle. (See smallest_rectangle2.)
  'convex'
               Each region is displayed by its convex hull (See
               convex.)
  'icon'
               Each region is displayed by the icon set with
               'set_icon' in the center of gravity.

Attention

Caution is advised for gray value output procedures with output parameter settings that use region output, e.g. disp_image with set_paint(::WindowHandle,'histogram':) and set_shape(::WindowHandle,'convex':). In that case the convex hull of the gray value histogram is displayed.

Parameters

WindowHandle (input_control)	window → (integer)
Window_id.

Shape (input_control)	string → (string)
Region output mode.
Default value: 'original'
List of values: 'original', 'convex', 'outer_circle', 'inner_circle', 'rectangle1', 'rectangle2', 'ellipse', 'icon'

Example

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_shape returns 2 (H_MSG_TRUE) if the parameter is correct and the window is valid. Otherwise an exception is raised.

Parallelization Information

set_shape is reentrant and processed without parallelization.

Possible Predecessors

set_icon, query_shape, get_shape

Possible Successors

disp_region

See also

get_shape, query_shape, disp_region

Module

Foundation