Start » Filter Reference » Surface » Surface Features » SurfaceProfileAlongPath

SurfaceProfileAlongPath


Module: Vision3DStandard

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.
Name Type Range Description
Input value
inSurface Surface Input surface
Input value
inScanPath Path Path along which the profile is extracted
Input value
inScanPathAlignment CoordinateSystem2D* Adjusts the scan path to the position of the inspected object
Input value
inSamplingStep Real* 0.0 - Distance between consecutive sampling points on the scan path; if Nil, the bigger of surface X and Y scales is chosen
Input value
inScanWidth Integer 1 - Width of the scan field
Input value
inSurfaceInterpolation InterpolationMethod Interpolation method used for extraction of surface points
Input value
inMaxInterpolationLength Integer* Maximal number of consecutive not existing profile points
Input value
inSmoothingStdDev Real 0.0 - 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 Path along which the scan is performed
Diagnostic input
diagSamplingPoints PathArray Array of paths each one containing the sampling points that contributed to a single value of the extracted profile; in the image coordinate system

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Non-positive sampling step on input in SurfaceProfileAlongPath.
DomainError Non-positive scale on input in SurfaceProfileAlongPath.

Complexity Level

This filter is available on Advanced Complexity Level.