Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / nan-2.5.5 / center.m

diff --git a/octave_packages/nan-2.5.5/center.m b/octave_packages/nan-2.5.5/center.m
new file mode 100644 (file)
index 0000000..8062f1a
--- /dev/null
+++ b/octave_packages/nan-2.5.5/center.m
@@ -0,0 +1,62 @@
+function [i,S] = center(i,DIM,W)
+% CENTER removes the mean 
+%
+% [z,mu] = center(x,DIM,W)
+%   removes mean x along dimension DIM
+%
+% x    input data 
+% DIM  dimension
+%      1: column
+%      2: row
+%      default or []: first DIMENSION, with more than 1 element
+% W    weights to computed weighted mean (default: [], all weights = 1)
+%      numel(W) must be equal to size(x,DIM)
+%
+% features:
+% - can deal with NaN's (missing values)
+% - weighting of data 
+% - dimension argument 
+% - compatible to Matlab and Octave
+%
+% see also: SUMSKIPNAN, MEAN, STD, DETREND, ZSCORE
+%
+% REFERENCE(S):
+
+%    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 2 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 <http://www.gnu.org/licenses/>.
+
+
+%       $Id: center.m 8223 2011-04-20 09:16:06Z schloegl $
+%       Copyright (C) 2000-2003,2005,2009 by Alois Schloegl <alois.schloegl@gmail.com>
+%       This is part of the NaN-toolbox. For more details see
+%       http://pub.ist.ac.at/~schloegl/matlab/NaN/
+
+
+if any(size(i)==0); return; end;
+
+if nargin<3,
+       W = [];
+end; 
+if nargin>1,
+        [S,N] = sumskipnan(i,DIM,W);
+else
+        [S,N] = sumskipnan(i,[],W);
+end;
+
+S     = S./N;
+szi = size(i);
+szs = size(S);
+if length(szs)<length(szi);
+        szs(length(szs)+1:length(szi)) = 1;
+end;
+i = i - repmat(S,szi./szs);            % remove mean