You are here: Start » AVL.NET » Function Reference » Surface » Surface Features » AVL.SurfaceLocalMinima

AVL.SurfaceLocalMinima

Finds surface locations characterized by locally minimal heights.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void SurfaceLocalMinima
(
	AvlNet.Surface inSurface,
	NullableRef<AvlNet.Region> inRoi,
	bool inConsiderLowlands,
	float? inMinHeight,
	float? inMaxHeight,
	float inMinDistance,
	AvlNet.SurfaceLocalExtremaVerification? inMinimaVerification,
	NullableRef<List<AvlNet.SurfaceExtremum>> outLocalMinima,
	NullableRef<SafeList<AvlNet.Region>> outMinimaRegions
)

Parameters

Name Type Range Default Description
inSurfaceAvlNet.Surface
inRoiAvlNet.NullableRef<AvlNet.Region>Range of pixels to be processed. Default value: atl::NIL.
inConsiderLowlandsboolConsider multi-pixel minima (lowlands) or not.
inMinHeightfloat?Minimal height of minimum to be considered. Default value: atl::NIL.
inMaxHeightfloat?Maximal height of minimum to be considered. Default value: atl::NIL.
inMinDistancefloat<0.0f, INF>Minimal distance between two found minima.
inMinimaVerificationAvlNet.SurfaceLocalExtremaVerification?Minima verification structure. Default value: atl::NIL.
outLocalMinimaAvlNet.NullableRef<System.Collections.Generic.List<AvlNet.SurfaceExtremum>>Found local minima. Can be null to skip this parameter calculation.
outMinimaRegionsAvlNet.NullableRef<AvlNet.SafeList<AvlNet.Region>>Regions of local minima (plateaus and singletons). Can be null to skip this parameter calculation.

Errors

List of possible exceptions:

Error type Description
DomainError Region of interest exceeds an input surface in SurfaceLocalMinima.

Function Overrides

See also