You are here: Start » FIL.NET » FIL.DilateImage

FIL.DilateImage

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

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

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

Parameters

Name Type Range Default Description
inImageFilNet.ImageInput image.
inRoiFilNet.NullableRef<FilNet.Region>Range of outImage pixels to be computed. Default value: ftl::NIL.
inSourceRoiFilNet.NullableRef<FilNet.Region>Range of inImage pixels to be considered in computations. Default value: ftl::NIL.
inBorderColorFilNet.Pixel?Color of the imaginary pixels outside the image boundaries. Default value: ftl::NIL.
inKernelFilNet.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: ftl::NIL.
outImageFilNet.ImageOutput image.
diagKernelFilNet.RegionKernel 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 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 DilateImage.
DomainError Not supported kernel on input in DilateImage.
DomainError Region exceeds an input image in DilateImage.

Function Overrides

See also