You are here: Start » Function Reference » Path » Path Metrics » PathToLineDistanceProfile

PathToLineDistanceProfile

Computes the profile of distances between a line and the characteristic points of a path.

Syntax

void fil::PathToLineDistanceProfile
(
	const fil::Path& inPath,
	const fil::Line2D& inLine,
	float inResolution,
	fil::Profile& outDistanceProfile,
	ftl::Optional<ftl::Array<float>&> outDistances = ftl::NIL,
	ftl::Optional<ftl::Array<fil::Segment2D>&> outConnectingSegments = ftl::NIL
)

Parameters

	Name	Type	Range	Default	Description
	inPath	const Path&			Input path
	inLine	const Line2D&			Input line
	inResolution	float	0.0 -	1.0f	Number of real-world units per one pixel
	outDistanceProfile	Profile&			Profile of distances between input line and consecutive points of input path
	outDistances	Optional<Array<float>&>		NIL	Distances between input line and consecutive points of input path
	outConnectingSegments	Optional<Array<Segment2D>&>		NIL	Segments connecting input line and consecutive points of input path having minimal length

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outDistances, outConnectingSegments.

Read more about Optional Outputs.

Errors