Operator Reference

area_center_points_xldarea_center_points_xldAreaCenterPointsXldAreaCenterPointsXldarea_center_points_xld (Operator)

area_center_points_xldarea_center_points_xldAreaCenterPointsXldAreaCenterPointsXldarea_center_points_xld — Area and center of gravity (centroid) of contours and polygons treated as point clouds.

Signature

area_center_points_xld(XLD : : : Area, Row, Column)

Herror area_center_points_xld(const Hobject XLD, double* Area, double* Row, double* Column)

Herror T_area_center_points_xld(const Hobject XLD, Htuple* Area, Htuple* Row, Htuple* Column)

void AreaCenterPointsXld(const HObject& XLD, HTuple* Area, HTuple* Row, HTuple* Column)

HTuple HXLD::AreaCenterPointsXld(HTuple* Row, HTuple* Column) const

double HXLD::AreaCenterPointsXld(double* Row, double* Column) const

static void HOperatorSet.AreaCenterPointsXld(HObject XLD, out HTuple area, out HTuple row, out HTuple column)

HTuple HXLD.AreaCenterPointsXld(out HTuple row, out HTuple column)

double HXLD.AreaCenterPointsXld(out double row, out double column)

def area_center_points_xld(xld: HObject) -> Tuple[Sequence[float], Sequence[float], Sequence[float]]

def area_center_points_xld_s(xld: HObject) -> Tuple[float, float, float]

Description

area_center_points_xldarea_center_points_xldAreaCenterPointsXldAreaCenterPointsXldarea_center_points_xld calculates the area and center of gravity (centroid) of the point clouds given by contours or polygons XLDXLDXLDXLDxld (i.e., the order of the points in the contour or polygon is not taken into account). The area corresponds to the number of points in the point cloud. The centroid is given by the arithmetic mean of all points. If the contour or polygon is closed (end point = start point), the end point of the contour or polygon is not taken into account to avoid that it receives twice the weight of the other points.

area_center_points_xldarea_center_points_xldAreaCenterPointsXldAreaCenterPointsXldarea_center_points_xld should be used if the contour XLDXLDXLDXLDxld intersects itself or if it is not possible to close the contour using a line from end to start point without self-intersection, because in this case area_center_xldarea_center_xldAreaCenterXldAreaCenterXldarea_center_xld does not produce useful results. To test whether the contours or polygons intersect themselves, test_self_intersection_xldtest_self_intersection_xldTestSelfIntersectionXldTestSelfIntersectionXldtest_self_intersection_xld can be used.

If more than one contour or polygon is passed, the results are stored in tuples in the same order as the respective contours or polygons in XLDXLDXLDXLDxld.

Attention

Even if the contour or polygon XLDXLDXLDXLDxld is not intersecting itself, the result of area_center_points_xldarea_center_points_xldAreaCenterPointsXldAreaCenterPointsXldarea_center_points_xld significantly differs from the result of area_center_xldarea_center_xldAreaCenterXldAreaCenterXldarea_center_xld as it is calculated from the point cloud and not from the enclosed region.

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

XLDXLDXLDXLDxld (input_object)  xld(-array) objectHXLDHObjectHObjectHobject

Point clouds to be examined in form of contours or polygons.

AreaAreaAreaareaarea (output_control)  real(-array) HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Area of the point cloud.

RowRowRowrowrow (output_control)  point.y(-array) HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Row coordinate of the centroid.

ColumnColumnColumncolumncolumn (output_control)  point.x(-array) HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Column coordinate of the centroid.

Complexity

Let n be the number of points of the contour or polygon. Then the run time is O(n).

Result

area_center_points_xldarea_center_points_xldAreaCenterPointsXldAreaCenterPointsXldarea_center_points_xld returns 2 ( H_MSG_TRUE) if the input is not empty. If the input is empty the behavior 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>). If necessary, an exception is raised.

Possible Predecessors

gen_contours_skeleton_xldgen_contours_skeleton_xldGenContoursSkeletonXldGenContoursSkeletonXldgen_contours_skeleton_xld, smooth_contours_xldsmooth_contours_xldSmoothContoursXldSmoothContoursXldsmooth_contours_xld, gen_polygons_xldgen_polygons_xldGenPolygonsXldGenPolygonsXldgen_polygons_xld

Alternatives

area_center_xldarea_center_xldAreaCenterXldAreaCenterXldarea_center_xld

See also

moments_points_xldmoments_points_xldMomentsPointsXldMomentsPointsXldmoments_points_xld, moments_any_points_xldmoments_any_points_xldMomentsAnyPointsXldMomentsAnyPointsXldmoments_any_points_xld, area_centerarea_centerAreaCenterAreaCenterarea_center, moments_region_2ndmoments_region_2ndMomentsRegion2ndMomentsRegion2ndmoments_region_2nd

Module

Foundation