You are here: Start » Function Reference » Image » Image Features » ImageRidges

ImageRidges

Header:	FIL.h
Namespace:	fil
Module:	FoundationBasic

Finds ridge pixels in an image.

Syntax

void fil::ImageRidges
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	fil::Polarity::Type inPolarity,
	ftl::Optional<float> inMinValue,
	ftl::Optional<float> inMaxValue,
	const float inNoiseLevel,
	fil::Region& outRidges
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inRoi	Optional<const Region&>		NIL	Range of pixels to be processed
inPolarity	Polarity::Type			Specifies the type of ridges to be detected (Bright, Dark or Any)
inMinValue	Optional<float>		NIL	Minimal value of pixel to be considered
inMaxValue	Optional<float>		NIL	Maximal value of pixel to be considered
inNoiseLevel	const float	0.0 -		Defines how much stronger a pixel has to be than its neighbors to be deemed a ridge pixel
outRidges	Region&			Region of ridges

Description

The operation finds region of pixels being local ridges on the image inImage within specific region inRoi. For a pixel to be deemed a ridge pixel it is necessary to be stronger than both its neighbor pixels in at least one from four main directions (horizontal, vertical and two diagonals) by at least inNoiseLevel. Furthermore, the pixel value must be between inMinValue and inMaxValue.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions: