Home > freetb4matlab > image > imfilter.m

imfilter

PURPOSE ^

% Computes the linear filtering of the image @var{I} and the filter @var{f}.

SYNOPSIS ^

function retval = imfilter(im, f, varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} @var{J} = imfilter(@var{I}, @var{f})
% @deftypefnx{Function File} @var{J} = imfilter(@var{I}, @var{f}, @var{options}, ...)
% Computes the linear filtering of the image @var{I} and the filter @var{f}.
% The computation is performed using double precision floating point numbers,
% but the class of the input image is preserved as the following example shows.
% @example
% I = 255*ones(100, 100, 'uint8');
% f = fspecial('average', 3);
% J = imfilter(I, f);
% class(J)
% @result{} ans = uint8
% @end example
%
% The function also accepts a number of optional arguments that control the
% details of the filtering. The following options is currently accepted
% @table @samp
% @item S
% If a scalar input argument is given, the image is padded with this scalar
% as part of the filtering. The default value is 0.
% @item 'symmetric'
% The image is padded symmetrically. 
% @item 'replicate'
% The image is padded using the border of the image.
% @item 'circular'
% The image is padded by circular repeating of the image elements.
% @item 'same'
% The size of the output image is the same as the input image. This is the default
% behaviour.
% @item 'full'
% Returns the full filtering result.
% @item 'corr'
% The filtering is performed using correlation. This is the default behaviour.
% @item 'conv'
% The filtering is performed using convolution.
% @end table
% @seealso{conv2, filter2, fspecial, padarray}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003