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

PathAlongArc

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

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

Applications: Usually used to revert an ImageAlongArc transformation.

Syntax

void fil::PathAlongArc
(
	const fil::Path& inPath,
	const fil::Arc2D& inAxis,
	fil::Axis::Type inAxisType,
	float inAxisCoordinate,
	bool inInverse,
	fil::Path& outPath
)

Parameters

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

In-place Processing

This function supports in-place data processing - you can pass the same reference to inPath and outPath

Description

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

Examples

ImageAlongArc performed on the sample image with inAxisType = X and inScanWidth = 50. Blue path on output image was reprojected on original image (as orange path) using PathAlongArc with inAxisType = X, inAxisCoordinate = 25, inInverse = true. ImageAlongArc and PathAlongArc used the same arc 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.