You are here: Start » FIL.NET » Function Reference » Path » Path Metrics » FIL.PathToLineDistanceProfile
Computes the profile of distances between a line and the characteristic points of a path.
Namespace: | FilNet |
---|---|
Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void PathToLineDistanceProfile ( FilNet.Path inPath, FilNet.Line2D inLine, float inResolution, FilNet.Profile outDistanceProfile, NullableRef<List<float>> outDistances, NullableRef<List<FilNet.Segment2D>> outConnectingSegments )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
![]() | inPath | FilNet.Path | Input path. | ||
![]() | inLine | FilNet.Line2D | Input line. | ||
![]() | inResolution | float | <0.0f, INF> | 1.0f | Number of real-world units per one pixel. Default value: 1.0f. |
![]() | outDistanceProfile | FilNet.Profile | Profile of distances between input line and consecutive points of input path. | ||
![]() | outDistances | FilNet.NullableRef<System.Collections.Generic.List<float>> | Distances between input line and consecutive points of input path. Can be null to skip this parameter calculation. | ||
![]() | outConnectingSegments | FilNet.NullableRef<System.Collections.Generic.List<FilNet.Segment2D>> | Segments connecting input line and consecutive points of input path having minimal length. Can be null to skip this parameter calculation. |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Indefinite line on input in PathToLineDistanceProfile. |