You are here: Start » FIL.NET » Invoke.SurfaceProfileAlongPath

Invoke.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:Fil
Assembly:FilNet.dll

Syntax

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

Parameters

Name Type Range Default Description
ioStateFil.ScanMapState
inSurfaceFil.SurfaceInput surface.
inScanPathFil.PathPath along which the profile is extracted.
inScanPathAlignmentFtl.Optional<Fil.CoordinateSystem2D>Adjusts the scan path to the position of the inspected object. Default value: ftl::NIL.
inSamplingStepFtl.Optional<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: ftl::NIL.
inScanWidthint<1, INF>5Width of the scan field. Default value: 5.
inSurfaceInterpolationFil.InterpolationMethodBilinearInterpolation method used for extraction of surface points. Default value: Bilinear.
inMaxInterpolationLengthFtl.Optional<int>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.
outProfileFil.ProfileThe resulting profile of the surface height.
outPathFil.PathThe path consisting of the points from which the resulting profile is extracted.
outAlignedScanPathFtl.Optional<Fil.Path>Path along which the scan is performed.
diagSamplingPointsFil.Diagnostic<System.Collections.Generic.List<Fil.Path>>Array of paths each one containing the sampling points that contributed to a single value of the extracted profile; in the image coordinate system.

See also