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

AVL.ErodeImage

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

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void ErodeImage
(
	AvlNet.Image inImage,
	NullableRef<AvlNet.Region> inRoi,
	NullableRef<AvlNet.Region> inSourceRoi,
	AvlNet.Pixel? inBorderColor,
	AvlNet.KernelShape inKernel,
	int inRadiusX,
	int? inRadiusY,
	AvlNet.Image outImage,
	AvlNet.Region diagKernel
)

Parameters

Name Type Range Default Description
inImageAvlNet.ImageInput image.
inRoiAvlNet.NullableRef<AvlNet.Region>Range of outImage pixels to be computed. Default value: atl::NIL.
inSourceRoiAvlNet.NullableRef<AvlNet.Region>Range of inImage pixels to be considered in computations. Default value: atl::NIL.
inBorderColorAvlNet.Pixel?Color of the imaginary pixels outside the image boundaries. Default value: atl::NIL.
inKernelAvlNet.KernelShapeKernel shape.
inRadiusXint<0, INF>1Nearly half of the kernel's width (2*R+1). Default value: 1.
inRadiusYint?<0, INF>Nearly half of the kernel's height (2*R+1), or same as inRadiusX. Default value: atl::NIL.
outImageAvlNet.ImageOutput image.
diagKernelAvlNet.RegionKernel 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.

Hardware acceleration settings may be manipulated with Settings class.

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.

Function Overrides

See also