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

FIL.PathAlongPath

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

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void PathAlongPath
(
	FilNet.Path inPath,
	FilNet.Path inAxis,
	FilNet.Axis inAxisType,
	float inAxisCoordinate,
	bool inInverse,
	FilNet.Path outPath
)

Parameters

Name Type Range Default Description
inPathFilNet.PathInput path.
inAxisFilNet.PathInput axis path.
inAxisTypeFilNet.AxisYType of axis the input axis path is parallel to. Default value: Y.
inAxisCoordinatefloat0.0fCoordinate of the axis path. Default value: 0.0f.
inInverseboolTrueSwitches to the inverse operation. Default value: True.
outPathFilNet.PathTransformed 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