clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXld (Operator)
Name
clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXld — Clip the end points of an XLD contour.
Signature
Description
The operator clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXldClipEndPointsContoursXld clips the end
points of an XLD contour. The parameter ModeModeModeModemode determines
the measure used to determine which part of the contour is clipped.
If ModeModeModeModemode = 'length'"length""length""length""length", the Euclidean length of the
part to be clipped is passed in LengthLengthLengthLengthlength. If ModeModeModeModemode
= 'num_points'"num_points""num_points""num_points""num_points", the number of points to be clipped is
passed in LengthLengthLengthLengthlength.
The clipped contour is returned in ClippedContoursClippedContoursClippedContoursClippedContoursclippedContours. 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
- 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
ContoursContoursContoursContourscontours (input_object) xld_cont(-array) → objectHXLDContHXLDContHobject
Input contour
ClippedContoursClippedContoursClippedContoursClippedContoursclippedContours (output_object) xld_cont(-array) → objectHXLDContHXLDContHobject *
Clipped contour
ModeModeModeModemode (input_control) string → HTupleHTupleHtuple (string) (string) (HString) (char*)
Clipping mode.
Default value:
'num_points'
"num_points"
"num_points"
"num_points"
"num_points"
List of values: 'length'"length""length""length""length", 'num_points'"num_points""num_points""num_points""num_points"
LengthLengthLengthLengthlength (input_control) number → HTupleHTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Clipping length in unit pixels (ModeModeModeModemode
= 'length') or number (ModeModeModeModemode =
'num_points')
Default value: 3
Suggested values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
Result
clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXldClipEndPointsContoursXld 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>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>). If necessary an
exception is raised.
Possible Predecessors
segment_contours_xldsegment_contours_xldSegmentContoursXldSegmentContoursXldSegmentContoursXld
See also
clip_contours_xldclip_contours_xldClipContoursXldClipContoursXldClipContoursXld,
crop_contours_xldcrop_contours_xldCropContoursXldCropContoursXldCropContoursXld
Module
Foundation