Back to Aurora Vision Library website

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

ProfileRidges


Header: AVL.h
Namespace: avl
Module: FoundationPro

Finds the high or low peaks in the input profile.

Applications: Can be used for 1D ridge detection when the brightness profile is extracted from an image in a non-standard way.

Syntax

C++
C#
 
void avl::ProfileRidges
(
	const avl::Profile& inProfile,
	atl::Optional<const avl::Range&> inRange,
	bool inCyclic,
	const avl::RidgeScanParams& inRidgeScanParams,
	float inMinDistance,
	atl::Optional<float> inMaxDistance,
	atl::Optional<const avl::LocalBlindness&> inLocalBlindness,
	atl::Array<avl::ProfileRidge>& outRidges,
	atl::Optional<atl::Array<float>&> outDistances = atl::NIL,
	atl::Optional<avl::Profile&> outResponseProfile = atl::NIL
)

Parameters

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

Read more about Optional Outputs.

Errors

List of possible exceptions:

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