You are here: Start » AVL.NET » AVL.SurfaceProfileAlongPath
Creates a series of segments across the input path, measures the average surface height on each of the segments, and creates the final profile from that values.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void SurfaceProfileAlongPath ( AvlNet.ScanMapState ioState, AvlNet.Surface inSurface, AvlNet.Path inScanPath, AvlNet.CoordinateSystem2D? inScanPathAlignment, float? inSamplingStep, int inScanWidth, AvlNet.InterpolationMethod inSurfaceInterpolation, int? inMaxInterpolationLength, float inSmoothingStdDev, AvlNet.Profile outProfile, AvlNet.Path outPath, AvlNet.Path outAlignedScanPath )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | AvlNet.ScanMapState | ||||
inSurface | AvlNet.Surface | Input surface. | |||
inScanPath | AvlNet.Path | Path along which the profile is extracted. | |||
inScanPathAlignment | AvlNet.CoordinateSystem2D? | Adjusts the scan path to the position of the inspected object. Default value: atl::NIL. | |||
inSamplingStep | float? | <0.0f, INF> | Distance between consecutive sampling points on the scan path; if Nil, the bigger of surface X and Y scales is chosen. Default value: atl::NIL. | ||
inScanWidth | int | <1, INF> | 5 | Width of the scan field. Default value: 5. | |
inSurfaceInterpolation | AvlNet.InterpolationMethod | Bilinear | Interpolation method used for extraction of surface points. Default value: Bilinear. | ||
inMaxInterpolationLength | int? | Maximal number of consecutive not existing profile points. Default value: atl::NIL. | |||
inSmoothingStdDev | float | <0.0f, INF> | 0.6f | Standard deviation of the gaussian smoothing applied to the extracted profile. Default value: 0.6f. | |
outProfile | AvlNet.Profile | The resulting profile of the surface height. | |||
outPath | AvlNet.Path | The path consisting of the points from which the resulting profile is extracted. | |||
outAlignedScanPath | AvlNet.Path | Path along which the scan is performed. |
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Non-positive sampling step on input in SurfaceProfileAlongPath. |
DomainError | Non-positive scale on input in SurfaceProfileAlongPath. |
Function Overrides
- SurfaceProfileAlongPath(ScanMapState, Surface, Path, Int32, InterpolationMethod, Single, Profile, Path)
- SurfaceProfileAlongPath(ScanMapState, Surface, Path, Int32, InterpolationMethod, Single, Profile, Path, Path)
- SurfaceProfileAlongPath(ScanMapState, Surface, Path, Int32, InterpolationMethod, Single, Profile, Path, IList<Path>)
- SurfaceProfileAlongPath(ScanMapState, Surface, Path, Int32, InterpolationMethod, Single, Profile, Path, Path, IList<Path>)
- SurfaceProfileAlongPath(ScanMapState, Surface, Path, Nullable<CoordinateSystem2D>, Nullable<Single>, Int32, InterpolationMethod, Nullable<Int32>, Single, Profile, Path)
- SurfaceProfileAlongPath(ScanMapState, Surface, Path, Nullable<CoordinateSystem2D>, Nullable<Single>, Int32, InterpolationMethod, Nullable<Int32>, Single, Profile, Path, IList<Path>)
- SurfaceProfileAlongPath(ScanMapState, Surface, Path, Nullable<CoordinateSystem2D>, Nullable<Single>, Int32, InterpolationMethod, Nullable<Int32>, Single, Profile, Path, Path, IList<Path>)