ScanMultipleRidges3D


Locates multiple high or low peaks of surface height along a given path.

Syntax

C++
C#
Python
 
def ScanMultipleRidges3D(
	inSurface: Surface,
	inScanMap: ScanMap,
	inRidgeScanParams: RidgeScanParams3D,
	inMinDistance: float,
	/,
	*,
	inMaxDistance: float | None = None,
	inLocalBlindness: LocalBlindness | None = None,
	inMaxProfileGapWidth: int | None = 1,
	outHeightProfile: Profile | None = None,
	outResponseProfile: Profile | None = None
)
-> outRidges: list[SurfaceRidge1D]

Parameters

Name Type Range Default Description
Input value inSurface Surface Input surface
Input value inScanMap ScanMap Data precomputed with CreateSurfaceScanMap
Input value inRidgeScanParams RidgeScanParams3D Parameters controlling the surface ridge extraction process
Input value inMinDistance float 0.0 - Minimal distance between consecutive ridges
Input value inMaxDistance float | None 0.0 - None Maximal distance between consecutive ridges
Input value inLocalBlindness LocalBlindness | None None Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges
Input value inMaxProfileGapWidth int | None 0 - 1 Maximal number of consecutive not existing profile points
Output value outRidges list[SurfaceRidge1D] Found surface ridges
Output value outHeightProfile Profile | None None Extracted surface height profile
Output value outResponseProfile Profile | None None Profile of the ridge operator response