Name
clip_regionclip_regionClipRegionClipRegion — Clip a region to a rectangle.
Herror clip_region(const Hobject Region, Hobject* RegionClipped, const Hlong Row1, const Hlong Column1, const Hlong Row2, const Hlong Column2)
Herror T_clip_region(const Hobject Region, Hobject* RegionClipped, const Htuple Row1, const Htuple Column1, const Htuple Row2, const Htuple Column2)
clip_regionclip_regionClipRegionClipRegionClipRegion clips the input regions to the rectangle
given by the four control parameters. clip_regionclip_regionClipRegionClipRegionClipRegion is
more efficient than calling intersectionintersectionIntersectionIntersectionIntersection with a
rectangle generated by gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1.
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Automatically parallelized on tuple level.
Row coordinate of the upper left corner of the
rectangle.
Default value: 0
Suggested values: 0, 128, 200, 256
Typical range of values:
Row1
Row1
Row1
Row1
row1
(lin)
Column coordinate of the upper left corner of the
rectangle.
Default value: 0
Suggested values: 0, 128, 200, 256
Typical range of values:
Column1
Column1
Column1
Column1
column1
(lin)
Row coordinate of the lower right corner of the
rectangle.
Default value: 256
Suggested values: 128, 200, 256, 512
Typical range of values: 0
≤
Row2
Row2
Row2
Row2
row2
≤
511 (lin)
Minimum increment: 1
Recommended increment: 10
Column coordinate of the lower right corner of the
rectangle.
Default value: 256
Suggested values: 128, 200, 256, 512
Typical range of values: 0
≤
Column2
Column2
Column2
Column2
column2
≤
511 (lin)
Minimum increment: 1
Recommended increment: 10
clip_regionclip_regionClipRegionClipRegionClipRegion 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.
thresholdthresholdThresholdThresholdThreshold,
connectionconnectionConnectionConnectionConnection,
regiongrowingregiongrowingRegiongrowingRegiongrowingRegiongrowing,
pouringpouringPouringPouringPouring
select_shapeselect_shapeSelectShapeSelectShapeSelectShape,
disp_regiondisp_regionDispRegionDispRegionDispRegion
intersectionintersectionIntersectionIntersectionIntersection,
gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1GenRectangle1,
clip_region_relclip_region_relClipRegionRelClipRegionRelClipRegionRel
Foundation