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

SurfaceLocalMinima

Header:	AVL.h
Namespace:	avl

Finds surface locations characterized by locally minimal heights.

Syntax

void avl::SurfaceLocalMinima
(
	const avl::Surface& inSurface,
	atl::Optional<const avl::Region&> inRoi,
	bool inConsiderLowlands,
	atl::Optional<float> inMinHeight,
	atl::Optional<float> inMaxHeight,
	float inMinDistance,
	atl::Optional<const avl::SurfaceLocalExtremaVerification&> inMinimaVerification,
	atl::Optional<atl::Array<avl::SurfaceExtremum>&> outLocalMinima,
	atl::Optional<atl::Array<avl::Region>&> outMinimaRegions = atl::NIL
)

Parameters

Name	Type	Range	Default	Description
inSurface	const Surface&
inRoi	Optional<const Region&>		NIL	Range of pixels to be processed
inConsiderLowlands	bool			Consider multi-pixel minima (lowlands) or not
inMinHeight	Optional<float>		NIL	Minimal height of minimum to be considered
inMaxHeight	Optional<float>		NIL	Maximal height of minimum to be considered
inMinDistance	float	0.0 -		Minimal distance between two found minima
inMinimaVerification	Optional<const SurfaceLocalExtremaVerification&>		NIL	Minima verification structure
outLocalMinima	Optional<Array<SurfaceExtremum>&>			Found local minima
outMinimaRegions	Optional<Array<Region>&>		NIL	Regions of local minima (plateaus and singletons)

Optional Outputs

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