You are here: Start » Function Reference » Path » Path Global Transforms » SegmentPath

SegmentPath

Header:	FIL.h
Namespace:	fil
Module:	FoundationPro

Splits a path into parts that can be approximated as segments or arcs.

Applications: Usually used to recognize a particular structure of an object contour or to guide a CNC machine.

Syntax

void fil::SegmentPath
(
	const fil::Path& inPath,
	float inSmoothingStdDev,
	float inMaxDeviation,
	fil::PathSegmentationMode::Type inSegmentationMode,
	ftl::Optional<float> inMaxArcRadius,
	ftl::Array<fil::Path>& outStraight,
	ftl::Array<fil::Path>& outArciform,
	ftl::Array<fil::Segment2D>& outSegments,
	ftl::Array<fil::Arc2D>& outArcs
)

Parameters

Name	Type	Range	Default	Description
inPath	const Path&			Path to be segmented
inSmoothingStdDev	float	0.0 -		Standard deviation used for initial gaussian smoothing of the segmented path
inMaxDeviation	float	0.0 -	0.5f	Maximal distance between any point of a classified segment to the abstract shape
inSegmentationMode	PathSegmentationMode::Type			Whether to use arcs for segmentation
inMaxArcRadius	Optional<float>	0.0 -	10.0f	Maximal radius of an arc fitted to segment
outStraight	Array<Path>&			Parts classified as straight segments
outArciform	Array<Path>&			Parts classified as arciform segments
outSegments	Array<Segment2D>&			Segments corresponding to sections of path from outStraight
outArcs	Array<Arc2D>&			Arcs corresponding to sections of path from outArciform

Description

The operation segments the inPath into parts of preferably simple shape. Each of the resulting parts is classified as one of the following:

Straight section - in which case it is returned in outStraight output array
Arciform section - in which case it is returned in outArciform output array

The operation guarantees that the maximal distance from any of the resulting path section to the corresponding abstract shape (line segment or circular arc) is less than inMaxDeviation.

Examples

The resulting outStraight array (some of the paths in the picture have common ends but in fact each straight part is a separate path).

The resulting outArciform array.

Errors

List of possible exceptions: