octave_packages/nan-2.5.5/nanconv.m

   1 function [C,N,c] = nanconv(X,Y,arg3)
   2 % NANCONV computes the convolution for data with missing values.
   3 %  X and Y can contain missing values encoded with NaN.
   4 %  NaN's are skipped, NaN do not result in a NaN output.
   5 %  The output gives NaN only if there are insufficient input data
   6 %
   7 % [...] = NANCONV(X,Y);
   8 %      calculates 2-dim convolution between X and Y
   9 % [C]   = NANCONV(X,Y);
  10 %
  11 % WARNING: missing values can introduce aliasing - causing unintended results.
  12 %    Moreover, the behavior of bandpass and highpass filters in case of missing values
  13 %    is not fully understood, and might contain some pitfalls.
  14 %
  15 % see also: CONV, NANCONV2, NANFFT, NANFILTER
  16
  17 %       $Id: conv2nan.m 6973 2010-02-28 20:19:12Z schloegl $
  18 %       Copyright (C) 2000-2005,2010,2011 by Alois Schloegl <alois.schloegl@gmail.com>
  19 %       This function is part of the NaN-toolbox
  20 %       http://pub.ist.ac.at/~schloegl/matlab/NaN/ and
  21 %       http://octave.svn.sourceforge.net/viewvc/octave/trunk/octave-forge/extra/NaN/inst/
  22
  23 %    This program is free software; you can redistribute it and/or modify
  24 %    it under the terms of the GNU General Public License as published by
  25 %    the Free Software Foundation; either version 3 of the License, or
  26 %    (at your option) any later version.
  27 %
  28 %    This program is distributed in the hope that it will be useful,
  29 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
  30 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31 %    GNU General Public License for more details.
  32 %
  33 %    You should have received a copy of the GNU General Public License
  34 %    along with this program; If not, see <http://www.gnu.org/licenses/>.
  35
  36
  37 warning('NANCONV is experimental. For more details see HELP NANCONV');
  38
  39
  40 if nargin~=2,
  41         fprintf(2,'Error NANCONV2: incorrect number of input arguments\n');
  42 end;
  43
  44 m = isnan(X);
  45 n = isnan(Y);
  46
  47 X(m) = 0;
  48 Y(n) = 0;
  49
  50 C = conv(X,Y);         % 2-dim convolution
  51 N = conv(real(~m),real(~n));     % normalization term
  52 c = conv(ones(size(X)),ones(size(Y))); % correction of normalization
  53
  54 if nargout==1,
  55         C = C.*c./N;
  56 elseif nargout==2,
  57         N = N./c;
  58 end;
  59