X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fstatistics-1.1.3%2Ftrimmean.m;fp=octave_packages%2Fstatistics-1.1.3%2Ftrimmean.m;h=901b00fd56ba44d4cd3ed157b87be23877fe7ebf;hp=0000000000000000000000000000000000000000;hb=c880e8788dfc484bf23ce13fa2787f2c6bca4863;hpb=1705066eceaaea976f010f669ce8e972f3734b05 diff --git a/octave_packages/statistics-1.1.3/trimmean.m b/octave_packages/statistics-1.1.3/trimmean.m new file mode 100644 index 0000000..901b00f --- /dev/null +++ b/octave_packages/statistics-1.1.3/trimmean.m @@ -0,0 +1,58 @@ +## 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{a} =} trimmean (@var{x}, @var{p}) +## +## Compute the trimmed mean. +## +## The trimmed mean of @var{x} is defined as the mean of @var{x} excluding the +## highest and lowest @var{p} percent of the data. +## +## For example +## +## @example +## mean ([-inf, 1:9, inf]) +## @end example +## +## is NaN, while +## +## @example +## trimmean ([-inf, 1:9, inf], 10) +## @end example +## +## excludes the infinite values, which make the result 5. +## +## @seealso{mean} +## @end deftypefn + +function a = trimmean(x, p, varargin) + if (nargin != 2 && nargin != 3) + print_usage; + endif + y = sort(x, varargin{:}); + sz = size(x); + if nargin < 3 + dim = min(find(sz>1)); + if isempty(dim), dim=1; endif; + else + dim = varargin{1}; + endif + idx = cell (0); + for i=1:length(sz), idx{i} = 1:sz(i); end; + trim = round(sz(dim)*p*0.01); + idx{dim} = 1+trim : sz(dim)-trim; + a = mean (y (idx{:}), varargin{:}); +endfunction