Back to FabImage Library website

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

SurfaceLocalMaxima


Header: FIL.h
Namespace: fil
Module: Vision3DStandard

Finds surface locations characterized by locally maximal heights.

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

Syntax

C++
C#
 
void fil::SurfaceLocalMaxima
(
	const fil::Surface& inSurface,
	ftl::Optional<const fil::Region&> inRoi,
	bool inConsiderPlateaus,
	ftl::Optional<float> inMinHeight,
	ftl::Optional<float> inMaxHeight,
	float inMinDistance,
	ftl::Optional<const fil::SurfaceLocalExtremaVerification&> inMaximaVerification,
	ftl::Optional<ftl::Array<fil::SurfaceExtremum>&> outLocalMaxima,
	ftl::Optional<ftl::Array<fil::Region>&> outMaximaRegions = 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 inConsiderPlateaus bool Consider multi-pixel maxima (plateaus) or not
Input value inMinHeight Optional<float> NIL Minimal height of maximum to be considered
Input value inMaxHeight Optional<float> NIL Maximal height of maximum to be considered
Input value inMinDistance float 0.0 - Minimal distance between two found maxima
Input value inMaximaVerification Optional<const SurfaceLocalExtremaVerification&> NIL Maxima verification structure
Output value outLocalMaxima Optional<Array<SurfaceExtremum>&> Found local maxima
Output value outMaximaRegions Optional<Array<Region>&> NIL Regions of local maxima (plateaus and singletons)

Optional Outputs

The computation of following outputs can be switched off by passing value ftl::NIL to these parameters: outLocalMaxima, outMaximaRegions.

Read more about Optional Outputs.

Errors

List of possible exceptions:

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