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

ScanExactlyNRidges3D

Header:	FIL.h
Namespace:	fil
Module:	Vision3DStandard

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

Syntax

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

Parameters

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

Optional Outputs

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