Home > m > sigproc > time_domain > ltpda_polydetrend.m

ltpda_polydetrend

PURPOSE ^

LTPDA_POLYDETREND detrends the input analysis object using a polynomial

SYNOPSIS ^

function varargout = ltpda_polydetrend(varargin)

DESCRIPTION ^

 LTPDA_POLYDETREND detrends the input analysis object using a polynomial
 of degree N.
 
 >> b = ltpda_polydetrend(a1,a2,a3,..., pl)
 
 Inputs:
   aN  - a list of analysis objects
   pl  - a parameter list
 
 Outputs:
   b - array of analysis objects
 
 If the last input argument is a parameter list (plist) it is used. The
 following parameters are recognised.
 
 Parameters:
   'N' - degree of polynomial [default: 1]
 
 The following call returns a parameter list object that contains the
 default parameter values:
 
 >> pl = ltpda_polydetrend('Params')
 
 
 M Hewitson, A Monsky 01-03-07
 
 $Id: ltpda_polydetrend.m,v 1.3 2007/06/12 12:32:14 hewitson Exp $

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function varargout = ltpda_polydetrend(varargin)
0002 
0003 % LTPDA_POLYDETREND detrends the input analysis object using a polynomial
0004 % of degree N.
0005 %
0006 % >> b = ltpda_polydetrend(a1,a2,a3,..., pl)
0007 %
0008 % Inputs:
0009 %   aN  - a list of analysis objects
0010 %   pl  - a parameter list
0011 %
0012 % Outputs:
0013 %   b - array of analysis objects
0014 %
0015 % If the last input argument is a parameter list (plist) it is used. The
0016 % following parameters are recognised.
0017 %
0018 % Parameters:
0019 %   'N' - degree of polynomial [default: 1]
0020 %
0021 % The following call returns a parameter list object that contains the
0022 % default parameter values:
0023 %
0024 % >> pl = ltpda_polydetrend('Params')
0025 %
0026 %
0027 % M Hewitson, A Monsky 01-03-07
0028 %
0029 % $Id: ltpda_polydetrend.m,v 1.3 2007/06/12 12:32:14 hewitson Exp $
0030 %
0031 
0032 % Check if this is a call for parameters
0033 if nargin == 1
0034   in = char(varargin{1});
0035   if strcmp(in, 'Params')
0036     varargout{1} = getDefaultPL();
0037     return
0038   end
0039 end
0040 
0041 % capture input variable names
0042 invars = {};
0043 as     = [];
0044 ps     = [];
0045 for j=1:nargin
0046   invars = [invars cellstr(inputname(j))];
0047   if isa(varargin{j}, 'ao')
0048     as = [as varargin{j}];
0049   end
0050   if isa(varargin{j}, 'plist')
0051     ps = [ps varargin{j}];
0052   end
0053 end
0054 
0055 ALGONAME = mfilename;
0056 VERSION  = '$Id: ltpda_polydetrend.m,v 1.3 2007/06/12 12:32:14 hewitson Exp $';
0057 
0058 % Look at inputs
0059 if nargin < 1
0060   error('### Incorrect number of inputs.')
0061 end
0062 
0063 na = length(as);
0064 
0065 % Combine plists
0066 if ~isempty(ps)
0067   pl = combine(ps, getDefaultPL());
0068 else
0069   pl = getDefaultPL();
0070 end
0071 
0072 % Initialise output
0073 bo = [];
0074 
0075 % Unpack parameter list
0076 N = find(pl, 'N');
0077 
0078 % Loop over analysis objects
0079 for i=1:na
0080   
0081   % get data out
0082   a = as(i);
0083   d = a.data;
0084   dinfo = whos('d');
0085   if ~isa(d, 'tsdata')
0086     error('### I only work with time-series at the moment.');
0087   end
0088   if ~isreal(d.x)
0089     error('### I only work with real time-series at the moment.');
0090   end
0091 
0092   y = polydetrend(d.x, N);
0093 
0094   % Make output analysis object
0095   nameStr = sprintf('poly_detrend(%s)', d.name);
0096   
0097   % create new output data
0098   data = tsdata(y, d.fs);
0099   data = set(data, 'name', nameStr);
0100   data = set(data, 'xunits', d.xunits);
0101   data = set(data, 'yunits', d.yunits);
0102 
0103   % create new output history
0104   h = history(ALGONAME, VERSION, pl, a.hist);
0105   h = set(h, 'invars', invars);
0106 
0107   % make output analysis object
0108   b = ao(data, h);
0109 
0110   % set name
0111   % name for this object
0112   if isempty(invars{i})
0113     n1 = a.name;
0114   else
0115     n1 = invars{i};
0116   end
0117 
0118   nameStr = sprintf('poly_detrend(%s)', n1);
0119   b = set(b, 'name', nameStr);
0120 
0121   % Add to output array
0122   bo = [bo b];
0123   
0124 end
0125 
0126 varargout{1} = bo;
0127 
0128 %--------------------------------------------------------------------------
0129 % Get default params
0130 function plo = getDefaultPL()
0131 
0132 disp('* creating default plist...');
0133 plo = plist();
0134 plo = append(plo, param('N', 1));
0135 disp('* done.');
0136 
0137 % END

Generated on Mon 02-Jul-2007 12:19:41 by m2html © 2003