Back to Aurora Vision Library website

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

PathToLineDistanceProfile


Header: AVL.h
Namespace: avl
Module: FoundationBasic

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

Syntax

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

Parameters

Name Type Range Default Description
Input value inPath const Path& Input path
Input value inLine const Line2D& Input line
Input value inResolution float 0.0 - 1.0f Number of real-world units per one pixel
Output value outDistanceProfile Profile& Profile of distances between input line and consecutive points of input path
Output value outDistances Optional<Array<float>&> NIL Distances between input line and consecutive points of input path
Output value 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 atl::NIL to these parameters: outDistances, outConnectingSegments.

Read more about Optional Outputs.

Errors

List of possible exceptions:

Error type Description
DomainError Indefinite line on input in PathToLineDistanceProfile.