You are here: Start » AVL.NET » Function Reference » Surface » Surface Features » AVL.SurfaceLocalMaxima
Finds surface locations characterized by locally maximal heights.
Namespace: | AvlNet |
---|---|
Assembly: | AVL.NET.dll |
Syntax
C++
C#
public static void SurfaceLocalMaxima ( AvlNet.Surface inSurface, bool inConsiderPlateaus, float? inMinHeight, float? inMaxHeight, float inMinDistance, NullableRef<List<AvlNet.SurfaceExtremum>> outLocalMaxima, NullableRef<SafeList<AvlNet.Region>> outMaximaRegions )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSurface | AvlNet.Surface | ||||
inConsiderPlateaus | bool | Consider multi-pixel maxima (plateaus) or not. | |||
inMinHeight | float? | Minimal height of maximum to be considered. Default value: atl::NIL. | |||
inMaxHeight | float? | Maximal height of maximum to be considered. Default value: atl::NIL. | |||
inMinDistance | float | <0.0f, INF> | Minimal distance between two found maxima. | ||
outLocalMaxima | AvlNet.NullableRef<System.Collections.Generic.List<AvlNet.SurfaceExtremum>> | Found local maxima. Can be null to skip this parameter calculation. | |||
outMaximaRegions | AvlNet.NullableRef<AvlNet.SafeList<AvlNet.Region>> | Regions of local maxima (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 SurfaceLocalMaxima. |