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

AVL.ErodeImage_Mask

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void ErodeImage_Mask
(
	AvlNet.Image inImage,
	NullableRef<AvlNet.Region> inRoi,
	AvlNet.MorphologyKernel inKernel,
	AvlNet.Image outImage
)

Parameters

Name Type Range Default Description
inImageAvlNet.ImageInput image.
inRoiAvlNet.NullableRef<AvlNet.Region>Range of outImage pixels to be computed. Default value: atl::NIL.
inKernelAvlNet.MorphologyKernelSelects a predefined kernel.
outImageAvlNet.ImageOutput 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 supports automatic parallelization for multicore and multiprocessor systems.

Hardware acceleration settings may be manipulated with Settings class.

Errors

List of possible exceptions:

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

Function Overrides

See also