Start » Filter Reference » Path » Path Metrics » PathToPointDistance

PathToPointDistance


Module: FoundationBasic

Computes the smallest distance between a path and a point.

Name Type Range Description
Input value
inPoint Point2D Input point
Input value
inPath Path Input path
Input value
inResolution Real 0.0 -
Output value
outDistance Real Minimal distance between input path and input point
Output value
outConnectingSegment Segment2D Segment connecting input path and input point having minimal length

Description

The operation computes the minimal distance between the inPoint and inPath and, additionally, the outConnectingSegment segment corresponding to the result.

Examples

The PathToPointDistance run on the sample data produces outDistance = 75.373.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Empty path on input in PathToPointDistance.

Complexity Level

This filter is available on Basic Complexity Level.

See Also

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