Skip to contents

Blurs an Image Using a Box Filter

Source: R/filters.R
boxFilter.Rd

boxFilter convolves the source image with the specified box kernel (a matrix of 1s). The result is a blurred version of the source image.

Usage

boxFilter(image, k_height = 5, k_width = 5, target = "new", in_place = NULL)

Arguments

image

An Image object.

k_height

The half-height in pixels of the kernel (default: 5).

k_width

The half-width in pixels of the kernel (default: 5).

target

The location where the results should be stored. It can take 3 values:

"new":

a new Image object is created and the results are stored inside (the default).

"self":

the results are stored back into image (faster but destructive).

An Image object:

the results are stored in another existing Image object. This is fast and will not replace the content of image but will replace that of target. Note that if target does not have the same dimensions, number of channels, and bit depth as image, an error may be thrown.

in_place

Deprecated. Use target instead.

Value

If target="new", the function returns an Image object. If target="self", the function returns nothing and modifies image in place. If target is an Image object, the function returns nothing and modifies that Image object in place.

See also

Image, blur, gaussianBlur

Author

Simon Garnier, garnier@njit.edu

Examples

balloon <- image(system.file("sample_img/balloon1.png", package = "Rvision"))
balloon_blur <- boxFilter(balloon, 11, 11)