The Octave Forge package repository is no longer actively maintained. Please find Octave Packages at https://packages.octave.org.

Navigation

Operators and Keywords

Function List:

C++ API

imboxfilt: J = imboxfilt(img)
imboxfilt: J = imboxfilt(…, fs)
imboxfilt: J = imboxfilt(…, name, value, … )

Produces box filtering J of image img, is quicker than imfilter.

Parameters:

img

The image to be filtered. Must be a matrix of numeric values.

fs

Size for the filter matrix. Must be a positive, odd integer or 2-element vector of positive odd integers. If fs is scalar, a squared box filter is used. Default is 3x3.

name, value

Additional options, given as name-value pairs:

padding

Determines how the image is padded. Value can be one of the following:

S

Pads the image with the scalar value S.

"replicate" (default)

Pads the image with the border pixel value.

"symmetric"

Pads the image by mirroring it at the image border.

"circular"

Pads the image with pixel values from the opposite image border, essentially treating the image as periodic.

NormalizationFactor

Normalization factor used, has to be a numeric scalar. Default is 1/(l*w), where l is the length and w is the width of the filter matrix.

The computation is performed using double precision floating point number, but the class of the input image is preserved. The function uses convolution based filtering or filtering with the integral image, depending on an internal heuristic.

See also: imfilter, imgaussfilt.

Package: image