You are here: Start » Function Reference » Image » Image Local Transforms » ErodeImage

ErodeImage

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

Replaces each pixel with the minimum of pixels within a kernel.

Applications: Thins bright features in an image and thickens dark ones.

Syntax

void fil::ErodeImage
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	ftl::Optional<const fil::Region&> inSourceRoi,
	ftl::Optional<fil::Pixel> inBorderColor,
	fil::KernelShape::Type inKernel,
	int inRadiusX,
	ftl::Optional<int> inRadiusY,
	fil::Image& outImage,
	fil::Region& diagKernel
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inRoi	Optional<const Region&>		NIL	Range of outImage pixels to be computed
inSourceRoi	Optional<const Region&>		NIL	Range of inImage pixels to be considered in computations
inBorderColor	Optional<Pixel>		NIL	Color of the imaginary pixels outside the image boundaries
inKernel	KernelShape::Type			Kernel shape
inRadiusX	int	0 -	1	Nearly half of the kernel's width (2*R+1)
inRadiusY	Optional<int>	0 -	NIL	Nearly half of the kernel's height (2*R+1), or same as inRadiusX
outImage	Image&			Output image
diagKernel	Region&			Kernel shape

Description

The operation replaces each pixel with the darkest pixel in its neighbourhood, thus shrinking bright areas in inImage and expanding the dark ones.

Examples

ErodeImage performed on the sample image with inKernel = Box, inRadiusX = 1, inRadiusY = 1.

Hardware Acceleration

This operation is optimized for SSE2 technology for pixels of types: all formats (when inSourceRoi = NIL and inBorderColor = NIL).

This operation is optimized for NEON technology for pixels of types: all formats (when inSourceRoi = NIL and inBorderColor = NIL).

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type	Description
DomainError	inBorderColor is relevant only when inSourceRoi is set to Auto (NIL) in ErodeImage.
DomainError	Not supported kernel on input in ErodeImage.
DomainError	Region exceeds an input image in ErodeImage.