Back to Aurora Vision Library website

You are here: Start » Function Reference » Computer Vision » 1D Edge Detection 3D » ScanExactlyNRidges3D


Header: AVL.h
Namespace: avl
Module: Vision3DStandard

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


void avl::ScanExactlyNRidges3D
	const avl::Surface& inSurface,
	const ScanMap& inScanMap,
	const avl::RidgeScanParams3D& inRidgeScanParams,
	int inRidgeCount,
	avl::Selection::Type inRidgeSelection,
	float inMinDistance,
	atl::Optional<float> inMaxDistance,
	atl::Optional<const avl::LocalBlindness&> inLocalBlindness,
	atl::Optional<int> inMaxProfileGapWidth,
	atl::Conditional<atl::Array<avl::SurfaceRidge1D> >& outRidges,
	atl::Optional<avl::Profile&> outHeightProfile = atl::NIL,
	atl::Optional<avl::Profile&> outResponseProfile = atl::NIL


Name Type Range Default Description
Input value
inSurface const Surface& Input surface
Input value
inScanMap const ScanMap& Data precomputed with CreateSurfaceScanMap
Input value
inRidgeScanParams const RidgeScanParams3D& Parameters controlling the surface ridge extraction process
Input value
inRidgeCount int 0 - 1 Number of ridges to be found
Input value
inRidgeSelection Selection::Type Selection::​Best Selection mode of the resulting ridges
Input value
inMinDistance float 0.0 - 0.0f Minimal distance between consecutive ridges
Input value
inMaxDistance Optional<float> 0.0 - NIL Maximal distance between consecutive ridges
Input value
inLocalBlindness Optional<const LocalBlindness&> NIL Defines conditions in which weaker ridges can be detected in the vicinity of stronger ridges
Input value
inMaxProfileGapWidth Optional<int> 0 - 1 Maximal number of consecutive not existing profile points
Output value
outRidges Conditional<Array<SurfaceRidge1D> >& Found surface ridges
Output value
outHeightProfile Optional<Profile&> NIL Extracted surface height profile
Output value
outResponseProfile Optional<Profile&> NIL Profile of the ridge operator response

Optional Outputs

The computation of following outputs can be switched off by passing value atl::NIL to these parameters: outHeightProfile, outResponseProfile.

Read more about Optional Outputs.