compactness_xld compactness_xld CompactnessXld CompactnessXld compactness_xld (Operator)
Name
compactness_xld compactness_xld CompactnessXld CompactnessXld compactness_xld
— Shape factor for the compactness of contours or polygons.
Signature
def compactness_xld (xld : HObject) -> Sequence[float]
def compactness_xld_s (xld : HObject) -> float
Description
The operator compactness_xld compactness_xld CompactnessXld CompactnessXld compactness_xld
calculates the compactness of each
input contour or polygon in XLD XLD XLD XLD xld
. The input contour or polygon must
not intersect itself, otherwise the resulting parameter is not meaningful
(Whether the input contour or polygon intersects itself or not can be
determined with test_self_intersection_xld test_self_intersection_xld TestSelfIntersectionXld TestSelfIntersectionXld test_self_intersection_xld
). If
the input contour or polygon is not closed it will be closed automatically.
Calculation:
If L is the length and F the
enclosed area of the contour or polygon the shape
factor Compactness Compactness Compactness compactness compactness
is defined as:
The shape factor Compactness Compactness Compactness compactness compactness
of a circle is 1.
If the contour or polygon encloses an elongated area Compactness Compactness Compactness compactness compactness
is larger than 1. The operator compactness_xld compactness_xld CompactnessXld CompactnessXld compactness_xld
responds to the
course of the contour or polygon (roughness).
If more than one contour or polygon is passed, the shape factors are stored
in a tuple in the same order as the respective contours or polygons in
XLD XLD XLD XLD xld
.
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
XLD XLD XLD XLD xld
(input_object) xld(-array) →
object HXLD HObject HObject Hobject
Contours or polygons to be examined.
Compactness Compactness Compactness compactness compactness
(output_control) real(-array) →
HTuple Sequence[float] HTuple Htuple (real) (double ) (double ) (double )
Compactness of the input contours or polygons.
Assertion:
Compactness >= 1.0 || Compactness == 0
Result
The operator compactness_xld compactness_xld CompactnessXld CompactnessXld compactness_xld
returns the value 2 (
H_MSG_TRUE )
if the input is not empty.
The behavior in case of empty input (no input contours 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>)
.
If necessary an exception is raised.
Possible Predecessors
gen_contours_skeleton_xld gen_contours_skeleton_xld GenContoursSkeletonXld GenContoursSkeletonXld gen_contours_skeleton_xld
,
edges_sub_pix edges_sub_pix EdgesSubPix EdgesSubPix edges_sub_pix
,
threshold_sub_pix threshold_sub_pix ThresholdSubPix ThresholdSubPix threshold_sub_pix
,
gen_contour_polygon_xld gen_contour_polygon_xld GenContourPolygonXld GenContourPolygonXld gen_contour_polygon_xld
,
test_self_intersection_xld test_self_intersection_xld TestSelfIntersectionXld TestSelfIntersectionXld test_self_intersection_xld
Alternatives
circularity_xld circularity_xld CircularityXld CircularityXld circularity_xld
,
convexity_xld convexity_xld ConvexityXld ConvexityXld convexity_xld
,
eccentricity_xld eccentricity_xld EccentricityXld EccentricityXld eccentricity_xld
,
rectangularity_xld rectangularity_xld RectangularityXld RectangularityXld rectangularity_xld
See also
area_center_xld area_center_xld AreaCenterXld AreaCenterXld area_center_xld
,
select_shape_xld select_shape_xld SelectShapeXld SelectShapeXld select_shape_xld
Module
Foundation