Skip to content

eccentricity_xldeccentricity_xldEccentricityXldEccentricityXldeccentricity_xldeccentricity_xld🔗

Short description🔗

eccentricity_xldeccentricity_xldEccentricityXldEccentricityXldeccentricity_xldeccentricity_xld — Shape features derived from the ellipse parameters of contours or polygons.

Signature🔗

eccentricity_xld( xld XLD, out real Anisometry, out real Bulkiness, out real StructureFactor )eccentricity_xld( XLD : : : Anisometry, Bulkiness, StructureFactor )void EccentricityXld( const HObject& XLD, HTuple* Anisometry, HTuple* Bulkiness, HTuple* StructureFactor )static void HOperatorSet.EccentricityXld( HObject XLD, out HTuple anisometry, out HTuple bulkiness, out HTuple structureFactor )def eccentricity_xld( xld: HObject ) -> Tuple[Sequence[float], Sequence[float], Sequence[float]]

def eccentricity_xld_s( xld: HObject ) -> Tuple[float, float, float]Herror eccentricity_xld( const Hobject XLD, double* Anisometry, double* Bulkiness, double* StructureFactor )

Herror T_eccentricity_xld( const Hobject XLD, Htuple* Anisometry, Htuple* Bulkiness, Htuple* StructureFactor )

HTuple HXLD::EccentricityXld( HTuple* Bulkiness, HTuple* StructureFactor ) const

double HXLD::EccentricityXld( double* Bulkiness, double* StructureFactor ) const

HTuple HXLD.EccentricityXld( out HTuple bulkiness, out HTuple structureFactor )

double HXLD.EccentricityXld( out double bulkiness, out double structureFactor )

Description🔗

The operator eccentricity_xldEccentricityXld calculates the three shape features Anisometryanisometryanisometry, Bulkinessbulkinessbulkiness, and StructureFactorstructureFactorstructure_factor derived from the geometric moments for each input contour or polygon. If the input contour or polygon is not closed it will be closed automatically.

Calculation: If the ellipse radii \(Ra\), \(Rb\) (elliptic_axis_xldEllipticAxisXld) and the enclosed area \(A\) of the contour or polygon are given, the following applies:

\[\begin{eqnarray*} \textrm{Anisometry} &=& \frac{Ra}{Rb} \\ \textrm{Bulkiness} &=& \frac{\pi \cdot Ra \cdot Rb}{F} \\ \textrm{StructureFactor} &=& \textrm{Anisometry} \cdot \textrm{Bulkiness} - 1 \end{eqnarray*}\]

The anisometry of a circle is 1.0.

It should be noted that eccentricity_xldEccentricityXld only returns useful results if the contour or polygon encloses a region in the plane. In particular, the contour or polygon must not intersect itself. This is particularly important if open contours or polygons are passed because they are closed automatically, which can produce a self-intersection. To test whether the contours or polygons intersect themselves, test_self_intersection_xldTestSelfIntersectionXld can be used. If the contour or polygon intersects itself, a useful value for the anisometry can be calculated with eccentricity_points_xldEccentricityPointsXld.

If more than one contour is passed the results are stored in tuples, the index of a value in the tuple corresponding to the index of a contour in the input.

Execution information🔗

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🔗

XLDXLDxld (input_object) xld(-array) → objectobjectHObjectHXLDHObjectHobject

Contours or polygons to be examined.

Anisometryanisometryanisometry (output_control) real(-array) → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Anisometry of the contours or polygons.

Assertion: Anisometry >= 1.0

Bulkinessbulkinessbulkiness (output_control) real(-array) → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Bulkiness of the contours or polygons.

StructureFactorstructureFactorstructure_factor (output_control) real(-array) → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Structure factor of the contours or polygons.

Result🔗

The operator eccentricity_xldEccentricityXld 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>). If necessary an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

gen_contours_skeleton_xldGenContoursSkeletonXld, edges_sub_pixEdgesSubPix, threshold_sub_pixThresholdSubPix, gen_contour_polygon_xldGenContourPolygonXld, test_self_intersection_xldTestSelfIntersectionXld

Alternatives

eccentricity_points_xldEccentricityPointsXld

See also

elliptic_axis_xldEllipticAxisXld, moments_region_2ndMomentsRegion2nd, select_shape_xldSelectShapeXld, area_center_xldAreaCenterXld

Module🔗

Foundation