Back to Aurora Vision Library website

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

DilateImage


Header: AVL.h
Namespace: avl
Module: FoundationLite

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

Applications: Thickens bright features in an images and thins dark ones.

Syntax

C++
C#
 
void avl::DilateImage
(
	const avl::Image& inImage,
	atl::Optional<const avl::Region&> inRoi,
	atl::Optional<const avl::Region&> inSourceRoi,
	atl::Optional<avl::Pixel> inBorderColor,
	avl::KernelShape::Type inKernel,
	int inRadiusX,
	atl::Optional<int> inRadiusY,
	avl::Image& outImage,
	avl::Region& diagKernel
)

Parameters

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

Description

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

Examples

DilateImage 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 DilateImage.
DomainError Not supported kernel on input in DilateImage.
DomainError Region exceeds an input image in DilateImage.

See Also

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