Home > m > sigproc > time_domain > ltpda_polydetrend.m

ltpda_polydetrend

PURPOSE ^

LTPDA_POLYDETREND detrends the input analysis object using a polynomial of degree N.

SYNOPSIS ^

function varargout = ltpda_polydetrend(varargin)

DESCRIPTION ^

 LTPDA_POLYDETREND detrends the input analysis object using a polynomial of degree N.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: LTPDA_POLYDETREND detrends the input analysis object using a
              polynomial of degree N.

 CALL:        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]


 VERSION:     $Id: ltpda_polydetrend.m,v 1.11 2008/08/10 20:24:50 hewitson Exp $

 HISTORY:     01-03-2007 M Hewitson
                 Creation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % LTPDA_POLYDETREND detrends the input analysis object using a polynomial of degree N.
0002 %
0003 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0004 %
0005 % DESCRIPTION: LTPDA_POLYDETREND detrends the input analysis object using a
0006 %              polynomial of degree N.
0007 %
0008 % CALL:        b = ltpda_polydetrend(a1,a2,a3,..., pl)
0009 %
0010 % INPUTS:      aN  - a list of analysis objects
0011 %              pl  - a parameter list
0012 %
0013 % OUTPUTS:     b - array of analysis objects
0014 %
0015 %              If the last input argument is a parameter list (plist) it is used.
0016 %              The following parameters are recognised.
0017 %
0018 % PARAMETERS:  'N' - degree of polynomial [default: 1]
0019 %
0020 %
0021 % VERSION:     $Id: ltpda_polydetrend.m,v 1.11 2008/08/10 20:24:50 hewitson Exp $
0022 %
0023 % HISTORY:     01-03-2007 M Hewitson
0024 %                 Creation
0025 %
0026 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0027 
0028 function varargout = ltpda_polydetrend(varargin)
0029 
0030   warning('!!! This function is deprecated and will be removed from future versions of LTPDA. Use ao/detrend now.');
0031 
0032   % Call ao/detrend
0033   bs =  detrend(varargin{:});
0034 
0035   % set output
0036   varargout{1} = bs;
0037 end
0038 % END

Generated on Mon 08-Sep-2008 13:18:47 by m2html © 2003