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

ErodeImage_Mask

Header:	FIL.h
Namespace:	fil
Module:	FoundationLite

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

Syntax

void fil::ErodeImage_Mask
(
	const fil::Image& inImage,
	ftl::Optional<const fil::Region&> inRoi,
	fil::MorphologyKernel::Type inKernel,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inRoi	Optional<const Region&>	NIL	Range of outImage pixels to be computed
inKernel	MorphologyKernel::Type		Selects a predefined kernel
outImage	Image&		Output image

Description

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

This filter is a simplified version of ErodeImage. It is limited to only a few symmetric kernels and supports only basic ROI handling.

Please note that on some machines the filter execution time can be greater than execution time of the corresponding ErodeImage filter.

Examples

ErodeImage_Mask performed on the sample image with inKernel = Box3x3.

Hardware Acceleration

This operation is optimized for SSE2 technology for pixels of types: UINT8, SINT16, UINT16.

This operation is optimized for AVX2 technology for pixels of types: UINT8, SINT16, UINT16.

This operation is optimized for NEON technology for pixels of types: UINT8, SINT8, SINT16, UINT16, SINT32, REAL.

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

List of possible exceptions:

Error type	Description
DomainError	Region exceeds an input image in ErodeImage_Mask.