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

PathToLineDistanceProfile

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

Syntax

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

void PathToLineDistanceProfile
(
	AvlNet.Path inPath,
	AvlNet.Line2D inLine,
	float inResolution,
	out AvlNet.Profile outDistanceProfile,
	out float[] outDistances,
	out AvlNet.Segment2D[] outConnectingSegments
)

Parameters

Name	Type	Range	Default	Description
inPath	const Path&			Input path
inLine	const Line2D&			Input line
inResolution	real	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<real>&>		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

Errors

Error type	Description
DomainError	Indefinite line on input in PathToLineDistanceProfile.