You are here: Start » FIL.NET » Function Reference » Surface » Surface Features » FIL.SurfaceProfileAlongPath

FIL.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 those values.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static void SurfaceProfileAlongPath
(
	FilNet.ScanMapState ioState,
	FilNet.Surface inSurface,
	FilNet.Path inScanPath,
	FilNet.CoordinateSystem2D? inScanPathAlignment,
	float? inSamplingStep,
	int inScanWidth,
	FilNet.InterpolationMethod inSurfaceInterpolation,
	int? inMaxInterpolationLength,
	float inSmoothingStdDev,
	FilNet.Profile outProfile,
	FilNet.Path outPath,
	NullableRef<FilNet.Path> outAlignedScanPath
)

Parameters

Name Type Range Default Description
ioStateFilNet.ScanMapState
inSurfaceFilNet.SurfaceInput surface.
inScanPathFilNet.PathPath along which the profile is extracted.
inScanPathAlignmentFilNet.CoordinateSystem2D?Adjusts the scan path to the position of the inspected object. Default value: ftl::NIL.
inSamplingStepfloat?<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: ftl::NIL.
inScanWidthint<1, INF>5Width of the scan field. Default value: 5.
inSurfaceInterpolationFilNet.InterpolationMethodBilinearInterpolation method used for extraction of surface points. Default value: Bilinear.
inMaxInterpolationLengthint?Maximal number of consecutive not existing profile points. Default value: ftl::NIL.
inSmoothingStdDevfloat<0.0f, INF>0.6fStandard deviation of the gaussian smoothing applied to the extracted profile. Default value: 0.6f.
outProfileFilNet.ProfileThe resulting profile of the surface height.
outPathFilNet.PathThe path consisting of the points from which the resulting profile is extracted.
outAlignedScanPathFilNet.NullableRef<FilNet.Path>Path along which the scan is performed. Can be null to skip this parameter calculation.

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

See also