Operator Reference

HALCON Operator Reference / XLD / Features
ClassesClasses | | Operators

eccentricity_xldeccentricity_xldEccentricityXldEccentricityXldeccentricity_xld (Operator)

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

Signature

eccentricity_xld(XLD : : : Anisometry, Bulkiness, StructureFactor)

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)

void EccentricityXld(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

static void HOperatorSet.EccentricityXld(HObject XLD, out HTuple anisometry, out HTuple bulkiness, out HTuple structureFactor)

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

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

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

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

Description

The operator eccentricity_xldeccentricity_xldEccentricityXldEccentricityXldeccentricity_xld calculates the three shape features AnisometryAnisometryAnisometryanisometryanisometry, BulkinessBulkinessBulkinessbulkinessbulkiness, and StructureFactorStructureFactorStructureFactorstructureFactorstructure_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_xldelliptic_axis_xldEllipticAxisXldEllipticAxisXldelliptic_axis_xld) and the enclosed area A of the contour or polygon are given, the following applies: The anisometry of a circle is 1.0.

It should be noted that eccentricity_xldeccentricity_xldEccentricityXldEccentricityXldeccentricity_xld 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_xldtest_self_intersection_xldTestSelfIntersectionXldTestSelfIntersectionXldtest_self_intersection_xld can be used. If the contour or polygon intersects itself, a useful value for the anisometry can be calculated with eccentricity_points_xldeccentricity_points_xldEccentricityPointsXldEccentricityPointsXldeccentricity_points_xld.

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

  • 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

Contours or polygons to be examined.

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

Anisometry of the contours or polygons.

Assertion: Anisometry >= 1.0

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

Bulkiness of the contours or polygons.

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

Structure factor of the contours or polygons.

Result

The operator eccentricity_xldeccentricity_xldEccentricityXldEccentricityXldeccentricity_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_xldgen_contours_skeleton_xldGenContoursSkeletonXldGenContoursSkeletonXldgen_contours_skeleton_xld, edges_sub_pixedges_sub_pixEdgesSubPixEdgesSubPixedges_sub_pix, threshold_sub_pixthreshold_sub_pixThresholdSubPixThresholdSubPixthreshold_sub_pix, gen_contour_polygon_xldgen_contour_polygon_xldGenContourPolygonXldGenContourPolygonXldgen_contour_polygon_xld, test_self_intersection_xldtest_self_intersection_xldTestSelfIntersectionXldTestSelfIntersectionXldtest_self_intersection_xld

Alternatives

eccentricity_points_xldeccentricity_points_xldEccentricityPointsXldEccentricityPointsXldeccentricity_points_xld

See also

elliptic_axis_xldelliptic_axis_xldEllipticAxisXldEllipticAxisXldelliptic_axis_xld, moments_region_2ndmoments_region_2ndMomentsRegion2ndMomentsRegion2ndmoments_region_2nd, select_shape_xldselect_shape_xldSelectShapeXldSelectShapeXldselect_shape_xld, area_center_xldarea_center_xldAreaCenterXldAreaCenterXldarea_center_xld

Module

Foundation

ClassesClasses | | Operators