Back to FabImage Library website

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

SurfaceLocalMinima


Header: FIL.h
Namespace: fil
Module: Vision3DStandard

Finds surface locations characterized by locally minimal heights.

Applications: Detection of characteristic points, usually after some surface transformations.

Syntax

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

Parameters

Name Type Range Default Description
Input value
 inSurface const Surface&
Input value
 inRoi Optional<const Region&> NIL Range of pixels to be processed
Input value
 inConsiderLowlands bool Consider multi-pixel minima (lowlands) or not
Input value
 inMinHeight Optional<float> NIL Minimal height of minimum to be considered
Input value
 inMaxHeight Optional<float> NIL Maximal height of minimum to be considered
Input value
 inMinDistance float 0.0 - Minimal distance between two found minima
Input value
 inMinimaVerification Optional<const SurfaceLocalExtremaVerification&> NIL Minima verification structure
Output value
 outLocalMinima Optional<Array<SurfaceExtremum>&> Found local minima
Output value
 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 ftl::NIL to these parameters: outLocalMinima, outMinimaRegions.

Read more about Optional Outputs.

Errors

List of possible exceptions:

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