Skip to contents

Blurs an Image Using a Square Box Filter

Source: R/filters.R
sqrBoxFilter.Rd

sqrBoxFilter calculates the normalized and unnormalized sum of squares of the pixels in a box surrounding focal pixel. The result is a blurred version of the source image.

Usage

sqrBoxFilter(
  image,
  k_height = 5,
  k_width = 5,
  normalize = TRUE,
  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).

normalize

Whether the kernel is to be normalized by its area (default: true).

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, boxFilter

Author

Simon Garnier, garnier@njit.edu

Examples

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