You are here: Start » Filter Reference » Image Local Transforms » SmoothImage_Mean

SmoothImage_Mean

Smooths an image by averaging pixels within a rectangular kernel.

Name	Type	Range	Description
inImage	Image		Input image
inRoi	Region *		Range of outImage pixels to be computed
inSourceRoi	Region *		Range of inImage pixels to be read
inBorderColor	Pixel *		Color of the imaginary pixels outside the image boundaries
inKernel	KernelShape		Kernel shape
inRadiusX	Integer	0 -	Nearly half of the kernel's width (2*R+1)
inRadiusY	Integer *	0 -	Nearly half of the kernel's height (2*R+1), or same as inRadiusX
outImage	Image		Output image

Applications

Usually used for computing features related to local image "windows". Can be also used for noise removal, but Gauss is superior here.

Description

Replaces each pixel with the average of all pixels contained in a rectangular kernel. The width of the kernel is 2 * inRadiusX + 1, the height is 2 * inRadiusY + 1. When inRadiusY is set to Auto, then its value is implicitly copied from inRadiusX.

Hints

Define the size of the kernel by setting inRadiusX and - optionally - inRadiusY.
Highest performance will be achieved with inKernel = Box. Other kernel shapes will result is longer execution time.
Define inSourceRoi is some pixels of the input images should be ignored (advanced).

Examples

SmoothImage_Mean performed on a sample image with inRadiusX = 4.

Hardware Acceleration

This operation supports automatic parallelization for multicore and multiprocessor systems.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type	Description
DomainError	inBorderColor is relevant only when inSourceRoi is set to Auto (NIL) in SmoothImage_Mean.
DomainError	Not supported kernel on input in SmoothImage_Mean.
DomainError	Region exceeds an input image in SmoothImage_Mean.

Complexity Level

This filter is available on Basic Complexity Level.

Filter Group

This filter is member of SmoothImage filter group.