Operator Reference

union_cotangential_contours_xldunion_cotangential_contours_xldUnionCotangentialContoursXldUnionCotangentialContoursXldunion_cotangential_contours_xld (Operator)

union_cotangential_contours_xldunion_cotangential_contours_xldUnionCotangentialContoursXldUnionCotangentialContoursXldunion_cotangential_contours_xld — Compute the union of cotangential contours.

Signature

Herror union_cotangential_contours_xld(const Hobject Contours, Hobject* UnionContours, double FitClippingLength, double FitLength, double MaxTangAngle, double MaxDist, double MaxDistPerp, double MaxOverlap, const char* Mode)

Herror T_union_cotangential_contours_xld(const Hobject Contours, Hobject* UnionContours, const Htuple FitClippingLength, const Htuple FitLength, const Htuple MaxTangAngle, const Htuple MaxDist, const Htuple MaxDistPerp, const Htuple MaxOverlap, const Htuple Mode)

void UnionCotangentialContoursXld(const HObject& Contours, HObject* UnionContours, const HTuple& FitClippingLength, const HTuple& FitLength, const HTuple& MaxTangAngle, const HTuple& MaxDist, const HTuple& MaxDistPerp, const HTuple& MaxOverlap, const HTuple& Mode)

HXLDCont HXLDCont::UnionCotangentialContoursXld(double FitClippingLength, const HTuple& FitLength, double MaxTangAngle, double MaxDist, double MaxDistPerp, double MaxOverlap, const HString& Mode) const

HXLDCont HXLDCont::UnionCotangentialContoursXld(double FitClippingLength, double FitLength, double MaxTangAngle, double MaxDist, double MaxDistPerp, double MaxOverlap, const HString& Mode) const

HXLDCont HXLDCont::UnionCotangentialContoursXld(double FitClippingLength, double FitLength, double MaxTangAngle, double MaxDist, double MaxDistPerp, double MaxOverlap, const char* Mode) const

HXLDCont HXLDCont::UnionCotangentialContoursXld(double FitClippingLength, double FitLength, double MaxTangAngle, double MaxDist, double MaxDistPerp, double MaxOverlap, const wchar_t* Mode) const   ( Windows only)

static void HOperatorSet.UnionCotangentialContoursXld(HObject contours, out HObject unionContours, HTuple fitClippingLength, HTuple fitLength, HTuple maxTangAngle, HTuple maxDist, HTuple maxDistPerp, HTuple maxOverlap, HTuple mode)

HXLDCont HXLDCont.UnionCotangentialContoursXld(double fitClippingLength, HTuple fitLength, double maxTangAngle, double maxDist, double maxDistPerp, double maxOverlap, string mode)

HXLDCont HXLDCont.UnionCotangentialContoursXld(double fitClippingLength, double fitLength, double maxTangAngle, double maxDist, double maxDistPerp, double maxOverlap, string mode)

def union_cotangential_contours_xld(contours: HObject, fit_clipping_length: float, fit_length: Union[float, str], max_tang_angle: float, max_dist: float, max_dist_perp: float, max_overlap: float, mode: str) -> HObject

Description

The operator union_cotangential_contours_xldunion_cotangential_contours_xldUnionCotangentialContoursXldUnionCotangentialContoursXldunion_cotangential_contours_xld unifies contours of the input XLD contour array ContoursContoursContourscontourscontours according to the local curvatures at their endpoints.

Parameters

FitClippingLengthFitClippingLengthFitClippingLengthfitClippingLengthfit_clipping_length

How does the union work? First, end pieces for each input contour in ContoursContoursContourscontourscontours are determined. The parameter FitClippingLengthFitClippingLengthFitClippingLengthfitClippingLengthfit_clipping_length specifies the Euclidean length that is temporarily clipped at both ends of a contour. With this parameter, it is possible to ignore artifacts at the endings of the input contours.

image/svg+xml a a
FitLengthFitLengthFitLengthfitLengthfit_length

With the parameter FitLengthFitLengthFitLengthfitLengthfit_length the Euclidean length of the end pieces that will be examined for the union is given. At each end of a contour at least that many points are assigned to an end piece that its length is greater or equal to FitLengthFitLengthFitLengthfitLengthfit_length. The value 'auto'"auto""auto""auto""auto" can be used here. The operator then tries to segment the contours into straights and arcs and takes the first and last segment as end pieces. As this is computationally intensive, it is recommended to use numerically specified values for the lengths whenever possible.

image/svg+xml a a

The operator tries to fit a circle into each end piece. Then, the endpoints of the input contours are determined that lie near enough to these circles (measured against the root mean square error of the circle fit). The tangents at these points correspond to the local curvature at the endings of the input contours.

If a circle fit fails, the operator tries to fit a regression line. Then, the local curvature of the endings of a contour corresponds to the direction of the regression line through the points of the end pieces.

image/svg+xml

The input contours are going to be unified according to the calculated local curvatures at their endpoints. Two contours are considered for the union if multiple thresholds are fulfilled at the same time:

MaxTangAngleMaxTangAngleMaxTangAnglemaxTangAnglemax_tang_angle

The parameter MaxTangAngleMaxTangAngleMaxTangAnglemaxTangAnglemax_tang_angle specifies the maximum angle between the tangents of two contours.

image/svg+xml a
MaxDistMaxDistMaxDistmaxDistmax_dist

The maximum distance of two endpoints is given with the parameter MaxDistMaxDistMaxDistmaxDistmax_dist.

image/svg+xml a
MaxDistPerpMaxDistPerpMaxDistPerpmaxDistPerpmax_dist_perp

The maximum distance perpendicular to the tangents is specified with the parameter MaxDistPerpMaxDistPerpMaxDistPerpmaxDistPerpmax_dist_perp. This distance is the minimum of the distances of the endpoints of the contours perpendicular to the other contour.

image/svg+xml a b
MaxOverlapMaxOverlapMaxOverlapmaxOverlapmax_overlap

As a last threshold, the overlap of the contours is considered. The amount of the overlap is determined by the projection of one endpoint onto the tangent of another contour and vice versa. The distances between the endpoints and their projections must be shorter than MaxOverlapMaxOverlapMaxOverlapmaxOverlapmax_overlap. Contrary to the other threshold values, MaxOverlapMaxOverlapMaxOverlapmaxOverlapmax_overlap can become negative. Negative values denote the minimum distance of the endpoints in the direction of the tangents.

image/svg+xml a b
. In this case, and are negative. See the reference manual entry of union_collinear_contours_ext_xldunion_collinear_contours_ext_xldUnionCollinearContoursExtXldUnionCollinearContoursExtXldunion_collinear_contours_ext_xld for an illustration with positive values for and .

It is possible, that a single contour is closed by this operator or multiple contours are merged into a single closed contour, if the criteria named above are fulfilled for the end pieces. Be aware that already closed contours are not considered for a union anymore.

If all thresholds are fulfilled between contours, a score value is calculated. The closer the calculated values for the angles and distances are to 0, the higher is the score value. The unification is then executed in the order of the score values. Thus, if there are multiple candidates for the unification, the best fitting contours are merged first.

The parameter ModeModeModemodemode states, whether existing attributes of the input contours should be copied to the output contours. 'attr_keep'"attr_keep""attr_keep""attr_keep""attr_keep" copies the attributes, which can have negative impacts on the performance of the operator. 'attr_forget'"attr_forget""attr_forget""attr_forget""attr_forget" causes the operator to ignore existing attributes. For further details see the description of the parameter Mode of the operator union_adjacent_contours_xldunion_adjacent_contours_xldUnionAdjacentContoursXldUnionAdjacentContoursXldunion_adjacent_contours_xld.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

ContoursContoursContourscontourscontours (input_object)  xld_cont-array objectHXLDContHObjectHObjectHobject

Input XLD contours.

UnionContoursUnionContoursUnionContoursunionContoursunion_contours (output_object)  xld_cont-array objectHXLDContHObjectHObjectHobject *

Output XLD contours.

FitClippingLengthFitClippingLengthFitClippingLengthfitClippingLengthfit_clipping_length (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Length of the part of a contour to skip for the determination of tangents.

Default: 0.0

Value range: 0.0 ≤ FitClippingLength FitClippingLength FitClippingLength fitClippingLength fit_clipping_length

FitLengthFitLengthFitLengthfitLengthfit_length (input_control)  real HTupleUnion[float, str]HTupleHtuple (real / string) (double / string) (double / HString) (double / char*)

Length of the part of a contour to use for the determination of tangents.

Default: 30.0

Suggested values: 10.0, 20.0, 30.0, 'auto'"auto""auto""auto""auto"

Value range: 0.0 ≤ FitLength FitLength FitLength fitLength fit_length

MaxTangAngleMaxTangAngleMaxTangAnglemaxTangAnglemax_tang_angle (input_control)  angle.rad HTuplefloatHTupleHtuple (real) (double) (double) (double)

Maximum angle difference between two contours' tangents.

Default: 0.78539816

Value range: 0.0 ≤ MaxTangAngle MaxTangAngle MaxTangAngle maxTangAngle max_tang_angle ≤ 3.1415926

MaxDistMaxDistMaxDistmaxDistmax_dist (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Maximum distance of the contours' end points.

Default: 25.0

Suggested values: 5.0, 10.0, 25.0, 50.0

Value range: 0.0 ≤ MaxDist MaxDist MaxDist maxDist max_dist

MaxDistPerpMaxDistPerpMaxDistPerpmaxDistPerpmax_dist_perp (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Maximum distance of the contours' end points perpendicular to their tangents.

Default: 10.0

Suggested values: 2.0, 5.0, 10.0, 20.0

Value range: 0.0 ≤ MaxDistPerp MaxDistPerp MaxDistPerp maxDistPerp max_dist_perp

MaxOverlapMaxOverlapMaxOverlapmaxOverlapmax_overlap (input_control)  real HTuplefloatHTupleHtuple (real) (double) (double) (double)

Maximum overlap of two contours.

Default: 2.0

Suggested values: 2.0, 5.0, 10.0, 20.0

ModeModeModemodemode (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Mode describing the treatment of the contours' attributes.

Default: 'attr_forget' "attr_forget" "attr_forget" "attr_forget" "attr_forget"

List of values: 'attr_forget'"attr_forget""attr_forget""attr_forget""attr_forget", 'attr_keep'"attr_keep""attr_keep""attr_keep""attr_keep"

Possible Predecessors

split_contours_xldsplit_contours_xldSplitContoursXldSplitContoursXldsplit_contours_xld, select_contours_xldselect_contours_xldSelectContoursXldSelectContoursXldselect_contours_xld

Alternatives

union_collinear_contours_xldunion_collinear_contours_xldUnionCollinearContoursXldUnionCollinearContoursXldunion_collinear_contours_xld, union_collinear_contours_ext_xldunion_collinear_contours_ext_xldUnionCollinearContoursExtXldUnionCollinearContoursExtXldunion_collinear_contours_ext_xld, union_cocircular_contours_xldunion_cocircular_contours_xldUnionCocircularContoursXldUnionCocircularContoursXldunion_cocircular_contours_xld, union_straight_contours_xldunion_straight_contours_xldUnionStraightContoursXldUnionStraightContoursXldunion_straight_contours_xld, union_adjacent_contours_xldunion_adjacent_contours_xldUnionAdjacentContoursXldUnionAdjacentContoursXldunion_adjacent_contours_xld

See also

edges_sub_pixedges_sub_pixEdgesSubPixEdgesSubPixedges_sub_pix, threshold_sub_pixthreshold_sub_pixThresholdSubPixThresholdSubPixthreshold_sub_pix, gen_polygons_xldgen_polygons_xldGenPolygonsXldGenPolygonsXldgen_polygons_xld, get_contour_xldget_contour_xldGetContourXldGetContourXldget_contour_xld, get_contour_attrib_xldget_contour_attrib_xldGetContourAttribXldGetContourAttribXldget_contour_attrib_xld

Module

Foundation