X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fstatistics-1.1.3%2Fnanmean.m;fp=octave_packages%2Fstatistics-1.1.3%2Fnanmean.m;h=9b3c22453bf173c0ebc5b7289c3f14f7d5b3d665;hp=0000000000000000000000000000000000000000;hb=c880e8788dfc484bf23ce13fa2787f2c6bca4863;hpb=1705066eceaaea976f010f669ce8e972f3734b05 diff --git a/octave_packages/statistics-1.1.3/nanmean.m b/octave_packages/statistics-1.1.3/nanmean.m new file mode 100644 index 0000000..9b3c224 --- /dev/null +++ b/octave_packages/statistics-1.1.3/nanmean.m @@ -0,0 +1,36 @@ +## Copyright (C) 2001 Paul Kienzle +## +## This program is free software; you can redistribute it and/or modify it under +## the terms of the GNU General Public License as published by the Free Software +## Foundation; either version 3 of the License, or (at your option) any later +## version. +## +## This program is distributed in the hope that it will be useful, but WITHOUT +## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +## details. +## +## You should have received a copy of the GNU General Public License along with +## this program; if not, see . + +## -*- texinfo -*- +## @deftypefn {Function File} {@var{v} =} nanmean (@var{X}) +## @deftypefnx{Function File} {@var{v} =} nanmean (@var{X}, @var{dim}) +## Compute the mean value while ignoring NaN values. +## +## @code{nanmean} is identical to the @code{mean} function except that NaN values +## are ignored. If all values are NaN, the mean is returned as NaN. +## +## @seealso{mean, nanmin, nanmax, nansum, nanmedian} +## @end deftypefn + +function v = nanmean (X, varargin) + if nargin < 1 + print_usage; + else + n = sum (!isnan(X), varargin{:}); + n(n == 0) = NaN; + X(isnan(X)) = 0; + v = sum (X, varargin{:}) ./ n; + endif +endfunction