Back to Aurora Vision Library website

You are here: Start » Function Reference » Path » Path Spatial Transforms » PathAlongPath

PathAlongPath


Header: AVL.h
Namespace: avl
Module: FoundationPro

Transforms a path to a coordinate system in which the 'axis' path is vertical or horizontal.

Applications: Usually used to revert an ImageAlongPath transformation.

Syntax

C++
C#
 
void avl::PathAlongPath
(
	const avl::Path& inPath,
	const avl::Path& inAxis,
	avl::Axis::Type inAxisType,
	float inAxisCoordinate,
	bool inInverse,
	avl::Path& outPath
)

Parameters

Name Type Default Description
Input value inPath const Path& Input path
Input value inAxis const Path& Input axis path
Input value inAxisType Axis::Type Y Type of axis the input axis path is parallel to
Input value inAxisCoordinate float 0.0f Coordinate of the axis path
Input value inInverse bool True Switches to the inverse operation
Output value outPath Path& Transformed path

Description

This filter transforms each point in inPath the same way how PointAlongPath does.

Examples

ImageAlongPath performed on the sample image with inAxisType = X and inScanWidth = 50. Blue path on output image was reprojected on original image using PathAlongPath with inAxisType = X, inAxisCoordinate = 25, inInverse = true. ImageAlongPath and PathAlongPath used the same path (the orange one) for transformations.

Remarks

No new points are being added to input path during transformation, and this may lead to some "distortions" of path. This is especially visible on long, straight portions of input path, which are described with only 2 points: the beginning one and the ending one. After transformation, such part of path is still a line, but it may not be corresponding to the transformed image. Easy way to overcome this problem is to increase number of points creating an transformed path.

Errors

List of possible exceptions:

Error type Description
DomainError Empty path on input in PathAlongPath.

See Also

  • ImageAlongPath – Creates an image from pixels traversed along a path.
  • PointAlongPath – Transforms a point to a coordinate system in which the 'axis' path is vertical or horizontal.
  • PathAlongArc – Transforms a path to a coordinate system in which the 'axis' arc is vertical or horizontal.