Operator Reference

get_region_polygonT_get_region_polygonGetRegionPolygonGetRegionPolygonget_region_polygon (Operator)

get_region_polygonT_get_region_polygonGetRegionPolygonGetRegionPolygonget_region_polygon — Polygon approximation of a region.

Signature

get_region_polygon(Region : : Tolerance : Rows, Columns)

Herror T_get_region_polygon(const Hobject Region, const Htuple Tolerance, Htuple* Rows, Htuple* Columns)

void GetRegionPolygon(const HObject& Region, const HTuple& Tolerance, HTuple* Rows, HTuple* Columns)

void HRegion::GetRegionPolygon(const HTuple& Tolerance, HTuple* Rows, HTuple* Columns) const

void HRegion::GetRegionPolygon(double Tolerance, HTuple* Rows, HTuple* Columns) const

static void HOperatorSet.GetRegionPolygon(HObject region, HTuple tolerance, out HTuple rows, out HTuple columns)

void HRegion.GetRegionPolygon(HTuple tolerance, out HTuple rows, out HTuple columns)

void HRegion.GetRegionPolygon(double tolerance, out HTuple rows, out HTuple columns)

def get_region_polygon(region: HObject, tolerance: Union[int, float]) -> Tuple[Sequence[int], Sequence[int]]

Description

The operator get_region_polygonget_region_polygonGetRegionPolygonGetRegionPolygonget_region_polygon calculates a polygon to approximate the edge of a region. A polygon is a sequence of line (RowsRowsRowsrowsrows) and column coordinates (ColumnsColumnsColumnscolumnscolumns). It describes the contour of the region. Only the base points of the polygon are returned. The parameter ToleranceToleranceTolerancetolerancetolerance indicates how large the maximum distance between the polygon and the edge of the region may be. Holes of the region are ignored. The operator get_region_polygonget_region_polygonGetRegionPolygonGetRegionPolygonget_region_polygon returns the coordinates in the form of tuples.

Attention

Holes of the region are ignored. Only one region may be passed, and this region must have exactly one connection component.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

RegionRegionRegionregionregion (input_object)  region objectHRegionHObjectHObjectHobject

Region to be approximated.

ToleranceToleranceTolerancetolerancetolerance (input_control)  number HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Maximum distance between the polygon and the edge of the region.

Default: 5.0

Suggested values: 0.0, 2.0, 5.0, 10.0

Value range: 0.0 ≤ Tolerance Tolerance Tolerance tolerance tolerance (lin)

Minimum increment: 0.01

Recommended increment: 1.0

RowsRowsRowsrowsrows (output_control)  polygon.y-array HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Line numbers of the base points of the contour.

ColumnsColumnsColumnscolumnscolumns (output_control)  polygon.x-array HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Column numbers of the base points of the contour.

Number of elements: Columns == Rows

Result

The operator get_region_polygonget_region_polygonGetRegionPolygonGetRegionPolygonget_region_polygon normally returns the value 2 ( H_MSG_TRUE) . If more than one connection component is passed an exception is raised. The behavior in case of empty input (no input regions available) is set via the operator 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>).

Possible Predecessors

sobel_ampsobel_ampSobelAmpSobelAmpsobel_amp, thresholdthresholdThresholdThresholdthreshold, skeletonskeletonSkeletonSkeletonskeleton, edges_imageedges_imageEdgesImageEdgesImageedges_image

See also

copy_objcopy_objCopyObjCopyObjcopy_obj, gen_region_polygongen_region_polygonGenRegionPolygonGenRegionPolygongen_region_polygon, disp_polygondisp_polygonDispPolygonDispPolygondisp_polygon, get_region_contourget_region_contourGetRegionContourGetRegionContourget_region_contour, set_line_approxset_line_approxSetLineApproxSetLineApproxset_line_approx

Module

Foundation