Operator Reference

HALCON Operator Reference / Regions / Transformations

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

clip_regionclip_regionClipRegionClipRegionclip_region (Operator)

clip_regionclip_regionClipRegionClipRegionclip_region — 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)

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

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)

def clip_region(region: HObject, row_1: int, column_1: int, row_2: int, column_2: int) -> HObject

Description

clip_regionclip_regionClipRegionClipRegionclip_region clips the input regions to the rectangle given by the four control parameters. clip_regionclip_regionClipRegionClipRegionclip_region is more efficient than calling intersectionintersectionIntersectionIntersectionintersection with a rectangle generated by gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1gen_rectangle1.

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) → objectHRegionHObjectHObjectHobject

Region to be clipped.

RegionClippedRegionClippedRegionClippedregionClippedregion_clipped (output_object)  region(-array) → objectHRegionHObjectHObjectHobject *

Clipped regions.

Row1Row1Row1row1row_1 (input_control)  rectangle.origin.y → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Row coordinate of the upper left corner of the rectangle.

Default: 0

Suggested values: 0, 128, 200, 256

Value range: Row1 Row1 Row1 row1 row_1 (lin)

Column1Column1Column1column1column_1 (input_control)  rectangle.origin.x → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column coordinate of the upper left corner of the rectangle.

Default: 0

Suggested values: 0, 128, 200, 256

Value range: Column1 Column1 Column1 column1 column_1 (lin)

Row2Row2Row2row2row_2 (input_control)  rectangle.corner.y → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Row coordinate of the lower right corner of the rectangle.

Default: 256

Suggested values: 128, 200, 256, 512

Value range: 0 ≤ Row2 Row2 Row2 row2 row_2 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

Column2Column2Column2column2column_2 (input_control)  rectangle.corner.x → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column coordinate of the lower right corner of the rectangle.

Default: 256

Suggested values: 128, 200, 256, 512

Value range: 0 ≤ Column2 Column2 Column2 column2 column_2 ≤ 511 (lin)

Minimum increment: 1

Recommended increment: 10

Result

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

Possible Predecessors

thresholdthresholdThresholdThresholdthreshold, connectionconnectionConnectionConnectionconnection, regiongrowingregiongrowingRegiongrowingRegiongrowingregiongrowing, pouringpouringPouringPouringpouring

Possible Successors

select_shapeselect_shapeSelectShapeSelectShapeselect_shape, disp_regiondisp_regionDispRegionDispRegiondisp_region

Alternatives

intersectionintersectionIntersectionIntersectionintersection, gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1gen_rectangle1, clip_region_relclip_region_relClipRegionRelClipRegionRelclip_region_rel

Module

Foundation

---

ClassesClasses | | Operators