Back to Adaptive Vision Library website

You are here: Start » Function Reference » Surface Features » SurfaceLocalMaxima

SurfaceLocalMaxima


Header:AVL.h
Namespace:avl

Finds surface locations characterized by locally maximal heights.

Syntax

C++
C#
 
void avl::SurfaceLocalMaxima
(
	const avl::Surface& inSurface,
	atl::Optional<const avl::Region&> inRoi,
	bool inConsiderPlateaus,
	atl::Optional<float> inMinHeight,
	atl::Optional<float> inMaxHeight,
	float inMinDistance,
	atl::Optional<const avl::SurfaceLocalExtremaVerification&> inMaximaVerification,
	atl::Optional<atl::Array<avl::SurfaceExtremum>&> outLocalMaxima,
	atl::Optional<atl::Array<avl::Region>&> outMaximaRegions = atl::NIL
)

Parameters

Name Type Range Default Description
inSurface const Surface&
inRoi Optional<const Region&> NIL Range of pixels to be processed
inConsiderPlateaus bool Consider multi-pixel maxima (plateaus) or not
inMinHeight Optional<float> NIL Minimal height of maximum to be considered
inMaxHeight Optional<float> NIL Maximal height of maximum to be considered
inMinDistance float 0.0 - Minimal distance between two found maxima
inMaximaVerification Optional<const SurfaceLocalExtremaVerification&> NIL Maxima verification structure
outLocalMaxima Optional<Array<SurfaceExtremum>&> Found local maxima
outMaximaRegions Optional<Array<Region>&> NIL Regions of local maxima (plateaus and singletons)

Optional Outputs

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

Read more about Optional Outputs.