ClassesClassesClassesClasses | | | | Operators

clip_regionclip_regionClipRegionclip_regionClipRegionClipRegion (Operator)

Name

clip_regionclip_regionClipRegionclip_regionClipRegionClipRegion — Clip a region to a rectangle.

Signature

clip_region(Region : RegionClipped : Row1, Column1, Row2, Column2 : )

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)

Herror clip_region(Hobject Region, Hobject* RegionClipped, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2)

HRegion HRegion::ClipRegion(const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2) const

HRegionArray HRegionArray::ClipRegion(const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2) const

void ClipRegion(const HObject& Region, HObject* RegionClipped, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2)

HRegion HRegion::ClipRegion(Hlong Row1, Hlong Column1, Hlong Row2, Hlong Column2) const

void HOperatorSetX.ClipRegion(
[in] IHUntypedObjectX* Region, [out] IHUntypedObjectX*RegionClipped, [in] VARIANT Row1, [in] VARIANT Column1, [in] VARIANT Row2, [in] VARIANT Column2)

IHRegionX* HRegionX.ClipRegion(
[in] Hlong Row1, [in] Hlong Column1, [in] Hlong Row2, [in] Hlong Column2)

static void HOperatorSet.ClipRegion(HObject region, out HObject regionClipped, HTuple row1, HTuple column1, HTuple row2, HTuple column2)

HRegion HRegion.ClipRegion(int row1, int column1, int row2, int column2)

Description

clip_regionclip_regionClipRegionclip_regionClipRegionClipRegion clips the input regions to the rectangle given by the four control parameters. clip_regionclip_regionClipRegionclip_regionClipRegionClipRegion is more efficient than calling intersectionintersectionIntersectionintersectionIntersectionIntersection with a rectangle generated by gen_rectangle1gen_rectangle1GenRectangle1gen_rectangle1GenRectangle1GenRectangle1.

Parallelization

Parameters

RegionRegionRegionRegionRegionregion (input_object)  region(-array) objectHRegionHRegionHRegionHRegionXHobject

Region to be clipped.

RegionClippedRegionClippedRegionClippedRegionClippedRegionClippedregionClipped (output_object)  region(-array) objectHRegionHRegionHRegionHRegionXHobject *

Clipped regions.

Row1Row1Row1Row1Row1row1 (input_control)  rectangle.origin.y HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

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 row1 (lin)

Column1Column1Column1Column1Column1column1 (input_control)  rectangle.origin.x HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

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 column1 (lin)

Row2Row2Row2Row2Row2row2 (input_control)  rectangle.corner.y HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

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 row2 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

Column2Column2Column2Column2Column2column2 (input_control)  rectangle.corner.x HTupleHTupleHTupleVARIANTHtuple (integer) (int / long) (Hlong) (Hlong) (Hlong) (Hlong)

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 column2 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

Result

clip_regionclip_regionClipRegionclip_regionClipRegionClipRegion 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>)set_system("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>)set_system("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>). If necessary, an exception is raised.

Possible Predecessors

thresholdthresholdThresholdthresholdThresholdThreshold, connectionconnectionConnectionconnectionConnectionConnection, regiongrowingregiongrowingRegiongrowingregiongrowingRegiongrowingRegiongrowing, pouringpouringPouringpouringPouringPouring

Possible Successors

select_shapeselect_shapeSelectShapeselect_shapeSelectShapeSelectShape, disp_regiondisp_regionDispRegiondisp_regionDispRegionDispRegion

Alternatives

intersectionintersectionIntersectionintersectionIntersectionIntersection, gen_rectangle1gen_rectangle1GenRectangle1gen_rectangle1GenRectangle1GenRectangle1, clip_region_relclip_region_relClipRegionRelclip_region_relClipRegionRelClipRegionRel

Module

Foundation


ClassesClassesClassesClasses | | | | Operators