You are here: Start » Function Reference » Profile Features » ProfileRidges

ProfileRidges

Header:	FIL.h
Namespace:	fil

Finds the high or low peaks in the input profile.

Syntax

void fil::ProfileRidges
(
	const fil::Profile& inProfile,
	ftl::Optional<const fil::Range&> inRange,
	bool inCyclic,
	const fil::RidgeScanParams& inRidgeScanParams,
	float inMinDistance,
	ftl::Optional<float> inMaxDistance,
	ftl::Optional<const fil::LocalBlindness&> inLocalBlindness,
	ftl::Array<fil::ProfileRidge>& outRidges,
	ftl::Optional<ftl::Array<float>&> outDistances = ftl::NIL,
	fil::Profile& diagResponseProfile = ftl::Dummy&lt;fil::Profile&gt;()
)

Parameters

Name	Type	Range	Default	Description
inProfile	const Profile&			Input profile
inRange	Optional<const Range&>		NIL
inCyclic	bool
inRidgeScanParams	const RidgeScanParams&		RidgeScanParams ( ProfileInterpolation: Quadratic4 SmoothingStdDev: 0.6f RidgeWidth: 5 RidgeMargin: 2 MinMagnitude: 5.0f RidgePolarity: Bright )	Parameters controlling the ridge extraction process
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
outRidges	Array<ProfileRidge>&			Found ridges
outDistances	Optional<Array<float>&>		NIL	Output distances between consecutive ridges
diagResponseProfile	Profile&			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: outDistances.

Errors

List of possible exceptions:

Error type	Description
DomainError	Range exceeds the input profile in ProfileRidges.