You are here: Start » AVL.NET » Function Reference » Document

Path Basics

Icon Name Description / Applications Modules
AppendPointToPath

Appends a point to a path.

FoundationLite
ClosePath

Adds the segment connecting the last point with the first one in a path.

FoundationLite
CreateArcPath

Creates an open path containing cocircular, equidistant points.

FoundationLite
CreateCirclePath

Creates a closed path containing cocircular, equidistant points.

FoundationLite
CreateEllipsePath

Creates a closed path containing elliptical, equidistant points.

FoundationLite
CreateRectanglePath

Creates a closed path containing four vertices of rectangle.

FoundationLite
CreateSegmentPath

Creates an open path containing collinear, equidistant points.

FoundationLite
GetPathCharacteristicPoint

Returns the selected characteristic point of a path.

FoundationLite
GetPathCharacteristicPoint_Interpolated

Returns linear interpolation between two consecutive characteristic points of a path.

FoundationLite
GetPathSegment

Returns the selected segment of a path.

FoundationLite
GetPointOnPath

Returns a path point of desired distance (measured along path) from the first point of the path.

FoundationLite
OpenPath

Removes the segment connecting the last point with the first one in a path.

FoundationLite
RemovePointFromPath

Removes a point from a path.

FoundationLite
SetPathCharacteristicPoint

Modifies the value of a selected characteristic point.

FoundationLite
SkipEmptyPath

If the input path has at least one point, then it is copied to the output; otherwise Nil is returned.


Secures against domain errors caused by empty paths, e.g. just before the PathBoundingBox filter is to be invoked.

FoundationLite
SkipNotPolygon

If the input path is closed and has no self-intersections, then it is copied to the output; otherwise Nil is returned.

FoundationLite
Subpath

Creates an open path from a continuous subsequence of the input path's points.

FoundationLite

Path Classification

Icon Name Description / Applications Modules
ClassifyPaths

Splits the paths of the input array - in accordance to the relation between computed feature values and the specified range.


Use this filter when you have an array of paths and you want to select some of them for further processing.

FoundationBasic
GetMaximumPath

Returns the path from the input array that corresponds to the largest computed feature value.


Use this filter when you have an array of paths and you want to select one of them that best matches some criterion.

FoundationBasic
GetMaximumPath_OrNil

Returns the path from the input array that corresponds to the largest computed feature value; returns NIL if the array or any path inside it is empty.


Use this filter when you have an array of paths and you want to select one of them that best matches some criterion.

FoundationBasic
GetMinimumPath

Returns the path from the input array that corresponds to the smallest computed feature value.


Use this filter when you have an array of paths and you want to select one of them that best matches some criterion.

FoundationBasic
GetMinimumPath_OrNil

Returns the path from the input array that corresponds to the smallest computed feature value; returns NIL if the array or any path inside it is empty.


Use this filter when you have an array of paths and you want to select one of them that best matches some criterion.

FoundationBasic
MakePathConditional

Computes a path feature, checks whether its value is in range and creates a conditional path on this basis.

FoundationBasic
SelectClosedPaths

Selects paths which are closed.

FoundationBasic
SelectInnerPaths

Selects paths which are visible from a point.

FoundationPro
SelectOpenPaths

Selects paths which are open.

FoundationBasic
SelectOuterPaths

Selects paths which do not obstruct visibility of other paths from a point.

FoundationPro
SortPaths

Changes the order of paths from the input array according to an ascending/descending sequence of their computed feature values.

FoundationBasic

Path Combinators

Icon Name Description / Applications Modules
AveragePath

Computes the average of two paths (of equal size and type) point by point.

FoundationLite
ConcatenatePaths

Joins two open paths.

FoundationLite
ConcatenatePaths_OfArray

Joins open paths of an array.

FoundationLite
ConcatenatePaths_OfLoop

Joins open paths appearing in consecutive iterations.

FoundationLite
JoinAdjacentPaths

Joins those paths of an array which endpoints lie near enough.

FoundationPro
PathLineIntersections

Computes the common points of a path and a line.

FoundationPro
PathPathIntersections

Computes the common points of two paths.

FoundationPro
PathSegmentIntersections

Computes the common points of a path and a segment.

FoundationPro
SplitPathByLine

Splits path in common points of a path and a line.

FoundationBasic
SplitPathByPath

Splits path in common points of two paths.

FoundationPro
SplitPathBySegment

Splits path in common points of a path and a segment.

FoundationBasic

Path Features

Icon Name Description / Applications Modules
PathArrayPoints

Converts an array of paths to an array of points.

FoundationLite
PathAverageTurnAngle

Computes the average absolute turn angle of a path per unit of length.

FoundationPro
PathBoundingBox

Computes the smallest box containing a path.

FoundationLite
PathBoundingBox_OrNil

Computes the smallest box containing a path; returns NIL if the path is empty.

FoundationLite
PathBoundingCircle

Computes the smallest circle enclosing a path.

FoundationBasic
PathBoundingCircle_OrNil

Computes the smallest circle enclosing a path; returns NIL if the path is empty.

FoundationBasic
PathBoundingParallelogram

Computes the smallest parallelogram containing a path.

FoundationPro
PathBoundingRectangle

Computes the smallest rectangle containing a path.

FoundationBasic
PathBoundingRectangle_FixedAngle

Computes the smallest rectangle with the given orientation angle containing a path.

FoundationBasic
PathBoundingRectangle_FixedAngle_OrNil

Computes the smallest rectangle with the given orientation angle containing a path; returns NIL when the path is empty.

FoundationBasic
PathBoundingRectangle_OrNil

Computes the smallest rectangle containing a path; returns NIL when the path is empty.

FoundationBasic
PathCaliperDiameter

Computes the longest and the shortest width of the input path measured as distance between parallel lines containing the whole path.

FoundationBasic
PathConvexHull

Computes the smallest convex shape that contains the given path.

FoundationBasic
PathDiameter

Finds the longest segment connecting two characteristic points of a path.

FoundationLite
PathEndpoints

Returns the two endpoints of a path.

FoundationLite
PathLength

Computes the total length of the input path.

FoundationLite
PathMassCenter

Computes the average of the path points (all, not only characteristic ones).

FoundationLite
PathMassCenter_OrNil

Computes the average of the path points (all, not only characteristic ones); returns NIL if the path is empty.

FoundationLite
PathSegments

Converts a path to an array of line segments.

FoundationLite
PathSelfIntersections

Checks if a path has any self-intersections and computes all of them.

FoundationPro
PathSize

Returns the number of characteristic points on the input path.

FoundationLite
PathTurnAngleLocalMaxima

Finds the local maxima of the profile of turn angles of a path.


Detection of feature points related to object corners.

FoundationPro
PathTurnAngleMaximum

Finds the maximum of the profile of turn angles of a path.

FoundationPro
PathTurnAngleMaximum_OrNil

Finds the maximum of the profile of turn angles of a path; returns NIL if the path has no turn angles.

FoundationPro
PathTurnAngleProfile

Computes the profile of turn angles at characteristic points of a path.

FoundationPro

Path Global Transforms

Icon Name Description / Applications Modules
ConvertToEquidistantPath

Creates a new path whose characteristic points lie on the input path, but are equally spaced.

FoundationBasic
CreateBicircularCurve

Creates a bicircular curve passing through the points of the leading path.


This is a fast algorithm that approximates Bezier's splines for dense paths.

FoundationBasic
ExtendPath

Resizes the first or the last segment of a path.

FoundationBasic
FindLongestSubpath

Creates a new path from the longest sequence of segments of the input path that turn gently.


Can be used for removing noise.

FoundationPro
ReducePath

Reduces the number of points in a path preserving its shape with the specified precision.

FoundationBasic
RemovePathSelfIntersections

Removes all self-intersections from a given path.

FoundationPro
SegmentPath

Splits a path into parts that can be approximated as segments or arcs.


Usually used to recognize a particular structure of an object contour or to guide a CNC machine.

FoundationPro

Path IO

Icon Name Description / Applications Modules
LoadPath

Loads serialized Path object from AVDATA file.

FoundationLite
SavePath

Saves serialized Path object as AVDATA file.

FoundationLite

Path Local Transforms

Icon Name Description / Applications Modules
SmoothPath_Gauss

Smooths a path by averaging its characteristic points within a kernel using gaussian-weighted average.

FoundationPro
SmoothPath_Mean

Smooths a path by averaging its characteristic points within a kernel.

FoundationPro

Path Metrics

Icon Name Description / Applications Modules
PathToLineDistance

Computes the smallest distance between a path and a line.

FoundationBasic
PathToLineDistanceProfile

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

FoundationBasic
PathToPathDistance

Computes the minimum distance between two paths.

FoundationPro
PathToPathDistanceProfile

Computes the profile of distances between two paths.

FoundationPro
PathToPathMaximumDistance

Computes the distance between the farthest point of the input path from the other path.

FoundationPro
PathToPointDistance

Computes the smallest distance between a path and a point.

FoundationBasic
PathToPointDistanceProfile

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

FoundationBasic

Path Spatial Transforms

Icon Name Description / Applications Modules
AlignPath

Moves a path from a local coordinate system to the absolute one.


Required when there is a path defined in a local coordinate system, but the next image-related filter in the program does not have any inAlignment input.

FoundationLite
AlignPathArray

Moves an array of paths from a local coordinate system to the absolute one.


Required when there are paths defined in a local coordinate system, but the next image-related filter in the program does not have any inAlignment input.

FoundationLite
FitPathToPath

Rotates and shifts a path to minimize average distance between its points and a reference path.

FoundationPro
InflatePath

Enlarges a shape by a given margin (points in the input path must be sorted clockwise).

FoundationPro
PathAlongArc

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


Usually used to revert an ImageAlongArc transformation.

FoundationBasic
PathAlongPath

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


Usually used to revert an ImageAlongPath transformation.

FoundationPro
PathProjectionProfile

Computes the distance from the line to the path.

FoundationPro
RescalePath

Translates each point of a path proportionally to its distance to a reference point.

FoundationLite
RescalePathArray

Translates each point of each path proportionally to its distance to a reference point.

FoundationLite
ReversePath

Reverses the order of points in a path.

FoundationLite
RotatePath

Rotates a path clockwise around a center point.

FoundationLite
RotatePathArray

Rotates an array of paths clockwise around a center point.

FoundationLite
ShiftPath

Moves every vertex of path along bisector of the angle between incident segments.

FoundationBasic
TranslatePath

Translates a path by a vector.

FoundationLite
TranslatePathArray

Translates an array of paths by a vector.

FoundationLite
TransposePath

Flips and rotates a path so that x-coordinates are exchanged with y-coordinates.

FoundationLite

Polygon Features

Icon Name Description / Applications Modules
PolygonArea

Computes the area of polygon.

FoundationBasic
PolygonCircularity

Computes the area of a polygon divided by the area of a circle having the same feature.

FoundationBasic
PolygonConvexity

Computes the area of a polygon divided by the area of its convex hull.

FoundationBasic
PolygonEllipticAxes

Computes axes of an ellipse having the same first and second order moments as the given polygon.

FoundationBasic
PolygonElongation

Computes the elongation factor of a polygon (perfect circle has minimal elongation equal 1.0).

FoundationBasic
PolygonInscribedCircle

Computes the circle with the maximal possible area contained in the input polygon.

FoundationBasic
PolygonMassCenter

Computes the mass center of polygon.

FoundationBasic
PolygonMoment

Computes the selected second-order moment of a polygon in regular and normalized ( divided by polygon area ) variant.

FoundationBasic
PolygonOrientation

Computes the polygon orientation as angle with value in range 0.0 - 180.0.

FoundationBasic
PolygonRectangularity

Computes the area of a polygon divided by the area of its bounding rectangle.

FoundationBasic
PolygonWithNormalizedOrientation

Returns the same polygon but with orientation corresponding to the axes.

FoundationBasic

Polygon Relations

Icon Name Description / Applications Modules
TestPointArrayInPolygon

Tests which points lie inside a polygon.

FoundationBasic
TestPointInPolygon

Tests whether a point lies inside a polygon.

FoundationLite
TestPolygonConvex

Tests whether a polygon is convex.

FoundationBasic
TestPolygonInPolygon

Tests whether a polygon lies inside another one.

FoundationBasic