length_xldlength_xldLengthXldLengthXldlength_xld (Operator)

Name

length_xldlength_xldLengthXldLengthXldlength_xld — Length of contours or polygons.

Signature

length_xld(XLD : : : Length)

Herror length_xld(const Hobject XLD, double* Length)

Herror T_length_xld(const Hobject XLD, Htuple* Length)

void LengthXld(const HObject& XLD, HTuple* Length)

HTuple HXLD::LengthXld() const

static void HOperatorSet.LengthXld(HObject XLD, out HTuple length)

HTuple HXLD.LengthXld()

def length_xld(xld: HObject) -> Sequence[float]

def length_xld_s(xld: HObject) -> float

Description

length_xldlength_xldLengthXldLengthXldLengthXldlength_xld calculates the length of the contours or polygons XLDXLDXLDXLDXLDxld. The length is calculated as the sum of the Euclidian distances of successive points on the contour or polygon. 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 XLDXLDXLDXLDXLDxld.

Execution Information

Parameters

XLDXLDXLDXLDXLDxld (input_object)  xld(-array) objectHXLDHObjectHXLDHobject

Contours or polygons to be examined.

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

Length of the contour or polygon.

Assertion: Length >= 0

Complexity

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

Result

length_xldlength_xldLengthXldLengthXldLengthXldlength_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>)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_xldGenContoursSkeletonXldGenContoursSkeletonXldGenContoursSkeletonXldgen_contours_skeleton_xld, smooth_contours_xldsmooth_contours_xldSmoothContoursXldSmoothContoursXldSmoothContoursXldsmooth_contours_xld, gen_polygons_xldgen_polygons_xldGenPolygonsXldGenPolygonsXldGenPolygonsXldgen_polygons_xld

See also

area_center_xldarea_center_xldAreaCenterXldAreaCenterXldAreaCenterXldarea_center_xld, moments_any_xldmoments_any_xldMomentsAnyXldMomentsAnyXldMomentsAnyXldmoments_any_xld, moments_xldmoments_xldMomentsXldMomentsXldMomentsXldmoments_xld, contlengthcontlengthContlengthContlengthContlengthcontlength

Module

Foundation