Skip to content

clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXldclip_end_points_contours_xldclip_end_points_contours_xld🔗

Short description🔗

clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXldclip_end_points_contours_xldclip_end_points_contours_xld — Clip the end points of an XLD contour.

Signature🔗

clip_end_points_contours_xld( xld_cont Contours, out xld_cont ClippedContours, string Mode, number Length )clip_end_points_contours_xld( Contours : ClippedContours : Mode, Length : )void ClipEndPointsContoursXld( const HObject& Contours, HObject* ClippedContours, const HTuple& Mode, const HTuple& Length )static void HOperatorSet.ClipEndPointsContoursXld( HObject contours, out HObject clippedContours, HTuple mode, HTuple length )def clip_end_points_contours_xld( contours: HObject, mode: str, length: Union[int, float] ) -> HObject

Herror clip_end_points_contours_xld( const Hobject Contours, Hobject* ClippedContours, const char* Mode, double Length )

Herror T_clip_end_points_contours_xld( const Hobject Contours, Hobject* ClippedContours, const Htuple Mode, const Htuple Length )

HXLDCont HXLDCont::ClipEndPointsContoursXld( const HString& Mode, const HTuple& Length ) const

HXLDCont HXLDCont::ClipEndPointsContoursXld( const HString& Mode, double Length ) const

HXLDCont HXLDCont::ClipEndPointsContoursXld( const char* Mode, double Length ) const

HXLDCont HXLDCont::ClipEndPointsContoursXld( const wchar_t* Mode, double Length ) const (Windows only)

HXLDCont HXLDCont.ClipEndPointsContoursXld( string mode, HTuple length )

HXLDCont HXLDCont.ClipEndPointsContoursXld( string mode, double length )

Description🔗

The operator clip_end_points_contours_xldClipEndPointsContoursXld clips the end points of an XLD contour. The parameter Modemodemode determines the measure used to determine which part of the contour is clipped.

If Modemodemode \(=\) 'length'"length", the Euclidean length of the part to be clipped is passed in Lengthlengthlength. If Modemodemode \(=\) 'num_points'"num_points", the number of points to be clipped is passed in Lengthlengthlength.

The clipped contour is returned in ClippedContoursclippedContoursclipped_contours. If all points of the input contour are clipped, no contour is returned. Therefore, the number of returned contours is less or equal to the number of input contours.

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🔗

Contourscontourscontours (input_object) xld_cont(-array) → objectobjectHObjectHXLDContHObjectHobject

Input contour

ClippedContoursclippedContoursclipped_contours (output_object) xld_cont(-array) → objectobjectHObjectHXLDContHObjectHobject *

Clipped contour

Modemodemode (input_control) string → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)

Clipping mode.

Default: 'num_points'"num_points"
List of values: 'length', 'num_points'"length", "num_points"

Lengthlengthlength (input_control) number → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[int, float]Htuple (double / Hlong)

Clipping length in unit pixels (Modemodemode \(=\) 'length'"length") or number (Modemodemode \(=\) 'num_points'"num_points")

Default: 33
Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 101, 2, 3, 4, 5, 6, 7, 8, 9, 10

Result🔗

clip_end_points_contours_xldClipEndPointsContoursXld returns 2 (H_MSG_TRUE) if the input is not empty. The behavior in case of empty input (no input contour 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

segment_contours_xldSegmentContoursXld

See also

clip_contours_xldClipContoursXld, crop_contours_xldCropContoursXld

Module🔗

Foundation