clip_region_relclip_region_relClipRegionRelClipRegionRel (Operator)

Name

clip_region_relclip_region_relClipRegionRelClipRegionRel — Clip a region relative to its smallest surrounding rectangle.

Signature

clip_region_rel(Region : RegionClipped : Top, Bottom, Left, Right : )

Description

clip_region_relclip_region_relClipRegionRelClipRegionRelClipRegionRel reduces the RegionRegionRegionRegionregion by eliminating parts close to the smallest surrounding rectangle of the RegionRegionRegionRegionregion. Specifically this means that the RegionRegionRegionRegionregion is clipped to a rectangle that is smaller than or equal to the smallest surrounding rectangle. The resulting clipped region is returned in RegionClippedRegionClippedRegionClippedRegionClippedregionClipped.

The rectangle to which the RegionRegionRegionRegionregion is clipped is determined by reducing the smallest surrounding axis-parallel rectangle at the top, bottom, left, and right side by the values given in TopTopTopToptop, BottomBottomBottomBottombottom, LeftLeftLeftLeftleft, and RightRightRightRightright, respectively.


(1)	(2)

Region with smallest surrounding rectangle (1) and clipped region (2).

These four parameters must contain numbers larger or equal to zero. If all parameters are set to zero, the region remains unchanged.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Automatically parallelized on tuple level.

Parameters

RegionRegionRegionRegionregion (input_object) region(-array) → object

Regions to be clipped.

RegionClippedRegionClippedRegionClippedRegionClippedregionClipped (output_object) region(-array) → object

Clipped regions.

TopTopTopToptop (input_control) integer → (integer)

Number of rows clipped at the top.

Default value: 1

Suggested values: 0, 1, 2, 3, 4, 5, 7, 10, 20, 30, 50

Typical range of values: 0 ≤ Top Top Top Top top (lin)

Minimum increment: 1

Recommended increment: 1

BottomBottomBottomBottombottom (input_control) integer → (integer)

Number of rows clipped at the bottom.

Default value: 1

Suggested values: 0, 1, 2, 3, 4, 5, 7, 10, 20, 30, 50

Typical range of values: 0 ≤ Bottom Bottom Bottom Bottom bottom (lin)

Minimum increment: 1

Recommended increment: 1

LeftLeftLeftLeftleft (input_control) integer → (integer)

Number of columns clipped at the left.

Default value: 1

Suggested values: 0, 1, 2, 3, 4, 5, 7, 10, 20, 30, 50

Typical range of values: 0 ≤ Left Left Left Left left (lin)

Minimum increment: 1

Recommended increment: 1

RightRightRightRightright (input_control) integer → (integer)

Number of columns clipped at the right.

Default value: 1

Suggested values: 0, 1, 2, 3, 4, 5, 7, 10, 20, 30, 50

Typical range of values: 0 ≤ Right Right Right Right right (lin)

Minimum increment: 1

Recommended increment: 1

Result

clip_region_relclip_region_relClipRegionRelClipRegionRelClipRegionRel returns 2 (H_MSG_TRUE) if all parameters are correct. The behavior in case of empty input (no regions given) can be set via set_system('no_object_result',<Result>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>) and the behavior in case of an empty input region via set_system('empty_region_result',<Result>)set_system("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>). If necessary, an exception is raised.

Possible Predecessors

thresholdthresholdThresholdThresholdThreshold, connectionconnectionConnectionConnectionConnection, regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowing, pouringpouringPouringPouringPouring

Possible Successors

select_shapeselect_shapeSelectShapeSelectShapeSelectShape, disp_regiondisp_regionDispRegionDispRegionDispRegion

Alternatives

smallest_rectangle1smallest_rectangle1SmallestRectangle1SmallestRectangle1SmallestRectangle1, intersectionintersectionIntersectionIntersectionIntersection, gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1, clip_regionclip_regionClipRegionClipRegionClipRegion

Module

Foundation