You are here: Start » FIL.NET » Function Reference » Surface » Surface Features » FIL.SurfaceLocalMinima
FIL.SurfaceLocalMinima
Finds surface locations characterized by locally minimal heights.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void SurfaceLocalMinima ( FilNet.Surface inSurface, bool inConsiderLowlands, float? inMinHeight, float? inMaxHeight, float inMinDistance, NullableRef<List<FilNet.SurfaceExtremum>> outLocalMinima, NullableRef<SafeList<FilNet.Region>> outMinimaRegions )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inSurface | FilNet.Surface | |||
| inConsiderLowlands | bool | Consider multi-pixel minima (lowlands) or not. | ||
| inMinHeight | float? | Minimal height of minimum to be considered. Default value: ftl::NIL. | ||
| inMaxHeight | float? | Maximal height of minimum to be considered. Default value: ftl::NIL. | ||
| inMinDistance | float | <0.0f, INF> | Minimal distance between two found minima. | |
 | outLocalMinima | FilNet.NullableRef<System.Collections.Generic.List<FilNet.SurfaceExtremum>> | Found local minima. Can be null to skip this parameter calculation. | ||
| outMinimaRegions | FilNet.NullableRef<FilNet.SafeList<FilNet.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. |
