You are here: Start » AVL.NET » Invoke.ScanExactlyNRidges3D

Invoke.ScanExactlyNRidges3D

Locates a specified number of the strongest high or low peaks of surface height along a given path.

Namespace:Avl
Assembly:AvlNet.dll

Syntax

C++
C#
 
public static void ScanExactlyNRidges3D
(
	Avl.Surface inSurface,
	Avl.ScanMap inScanMap,
	Avl.RidgeScanParams3D inRidgeScanParams,
	int inRidgeCount,
	Avl.Selection inRidgeSelection,
	float inMinDistance,
	Optional<float> inMaxDistance,
	Optional<Avl.LocalBlindness> inLocalBlindness,
	Optional<int> inMaxProfileGapWidth,
	Conditional<List<Avl.SurfaceRidge1D>> outRidges,
	Optional<Avl.Profile> outHeightProfile,
	Optional<Avl.Profile> outResponseProfile
)

Parameters

Name Type Range Default Description
inSurfaceAvl.SurfaceInput surface.
inScanMapAvl.ScanMapData precomputed with CreateSurfaceScanMap.
inRidgeScanParamsAvl.RidgeScanParams3DParameters controlling the surface ridge extraction process.
inRidgeCountint<0, INF>1Number of ridges to be found. Default value: 1.
inRidgeSelectionAvl.Selectionavl::Selection::BestSelection mode of the resulting ridges. Default value: avl::Selection::Best.
inMinDistancefloat<0.0f, INF>0.0fMinimal distance between consecutive ridges. Default value: 0.0f.
inMaxDistanceAtl.Optional<float><0.0f, INF>Maximal distance between consecutive ridges. Default value: atl::NIL.
inLocalBlindnessAtl.Optional<Avl.LocalBlindness>Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges. Default value: atl::NIL.
inMaxProfileGapWidthAtl.Optional<int><0, INF>1Maximal number of consecutive not existing profile points. Default value: 1.
outRidgesAtl.Conditional<System.Collections.Generic.List<Avl.SurfaceRidge1D>>Found surface ridges.
outHeightProfileAtl.Optional<Avl.Profile>Extracted surface height profile.
outResponseProfileAtl.Optional<Avl.Profile>Profile of the ridge operator response.

See also