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.

Applications:This is the first step of all 1D Edge Detection 3D operations. Here available for direct use by the user.

Syntax

C++
C#
Python
 
def SurfaceProfileAlongPath(
	state: ScanMapState,
	inSurface: Surface,
	inScanPath: Path,
	outProfile: Profile,
	outPath: Path,
	/,
	*,
	inScanPathAlignment: CoordinateSystem2D | None = None,
	inSamplingStep: float | None = None,
	inScanWidth: int = 5,
	inSurfaceInterpolation: InterpolationMethod = InterpolationMethod.Bilinear,
	inMaxInterpolationLength: int | None = None,
	inSmoothingStdDev: float = 0.6,
	outAlignedScanPath: Path | None = None
)
-> diagSamplingPoints: list[Path]

Parameters

Name Type Range Default Description
Input will be modified ioState ScanMapState
Input value inSurface Surface Input surface
Input value inScanPath Path Path along which the profile is extracted
Input value inScanPathAlignment CoordinateSystem2D | None None Adjusts the scan path to the position of the inspected object
Input value inSamplingStep float | None 0.0 - None Distance between consecutive sampling points on the scan path; if Nil, the bigger of surface X and Y scales is chosen
Input value inScanWidth int 1 - 5 Width of the scan field
Input value inSurfaceInterpolation InterpolationMethod InterpolationMethod.Bilinear Interpolation method used for extraction of surface points
Input value inMaxInterpolationLength int | None None Maximal number of consecutive not existing profile points
Input value inSmoothingStdDev float 0.0 - 0.6 Standard deviation of the gaussian smoothing applied to the extracted profile
Output value outProfile Profile The resulting profile of the surface height
Output value outPath Path The path consisting of the points from which the resulting profile is extracted
Output value outAlignedScanPath Path | None None Path along which the scan is performed
Diagnostic input diagSamplingPoints list[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