clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXldclip_end_points_contours_xld (Operator)
Name
clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXldclip_end_points_contours_xld — Clip the end points of an XLD contour.
Signature
def clip_end_points_contours_xld(contours: HObject, mode: str, length: Union[int, float]) -> HObject
Description
The operator clip_end_points_contours_xldclip_end_points_contours_xldClipEndPointsContoursXldClipEndPointsContoursXldClipEndPointsContoursXldclip_end_points_contours_xld clips the end
points of an XLD contour. The parameter ModeModeModeModemodemode determines
the measure used to determine which part of the contour is clipped.
If ModeModeModeModemodemode = 'length'"length""length""length""length""length", the Euclidean length of the
part to be clipped is passed in LengthLengthLengthLengthlengthlength. If ModeModeModeModemodemode
= 'num_points'"num_points""num_points""num_points""num_points""num_points", the number of points to be clipped is
passed in LengthLengthLengthLengthlengthlength.
The clipped contour is returned in ClippedContoursClippedContoursClippedContoursClippedContoursclippedContoursclipped_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
- 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
ContoursContoursContoursContourscontourscontours (input_object) xld_cont(-array) → objectHXLDContHObjectHXLDContHobject
Input contour
ClippedContoursClippedContoursClippedContoursClippedContoursclippedContoursclipped_contours (output_object) xld_cont(-array) → objectHXLDContHObjectHXLDContHobject *
Clipped contour
ModeModeModeModemodemode (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Clipping mode.
Default value:
'num_points'
"num_points"
"num_points"
"num_points"
"num_points"
"num_points"
List of values: 'length'"length""length""length""length""length", 'num_points'"num_points""num_points""num_points""num_points""num_points"
LengthLengthLengthLengthlengthlength (input_control) number → HTupleUnion[int, float]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Clipping length in unit pixels (ModeModeModeModemodemode
= 'length') or number (ModeModeModeModemodemode =
'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_xldClipEndPointsContoursXldClipEndPointsContoursXldClipEndPointsContoursXldclip_end_points_contours_xld 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>)set_system("no_object_result",<Result>). If necessary an
exception is raised.
Possible Predecessors
segment_contours_xldsegment_contours_xldSegmentContoursXldSegmentContoursXldSegmentContoursXldsegment_contours_xld
See also
clip_contours_xldclip_contours_xldClipContoursXldClipContoursXldClipContoursXldclip_contours_xld,
crop_contours_xldcrop_contours_xldCropContoursXldCropContoursXldCropContoursXldcrop_contours_xld
Module
Foundation