Home > m > sigproc > frequency_domain > ltpda_lpsd.m

ltpda_lpsd

PURPOSE ^

LTPDA_LPSD implement LPSD algorithm for analysis objects.

SYNOPSIS ^

function varargout = ltpda_lpsd(varargin)

DESCRIPTION ^

 LTPDA_LPSD implement LPSD algorithm for analysis objects.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 LTPDA_LPSD implement LPSD algorithm for analysis objects.

   >> bs = ltpda_lpsd(as)

   Inputs:
     as  - array of analysis objects
     pl  - parameter list (see below)

   Outputs:
     bs  - array of analysis objects, one for each input

   Parameter list:
     Kdes  - desired number of averages   (default 100)
     Lmin  - minimum segment length   (default 0)
     Jdes  - number of spectral frequencies to compute (default fs/2)
     win   - a specwin window object
             Only the design parameters of the window object are used; the
             window is recomputed for each DFT length inside the lpsd_core
             algorithm.
     Olap - desired overlap percentage (default: taken from window)
     Order - order of detrending
             -1 - no detrending
              0 - subtract mean
              1 - subtract linear fit
              N - subtract fit of polynomial, order N
     Scale - Scaling of output. Choose from:
               AS  - Amplitude (linear) Spectrum
               ASD - Amplitude (linear) Spectral Density
               PS  - Power Spectrum
               PSD - Power Spectral Density [default]

 The following call returns a parameter list object that contains the
 default parameter values:

 >> pl = ltpda_lpsd('Params')

 The following call returns a string that contains the routine CVS version:

 >> version = ltpda_lpsd('Version')

 The following call returns a string that contains the routine category:

 >> category = ltpda_lpsd('Category')

 References:
     "Improved spectrum estimation from digitized time series
      on a logarithmic frequency axis", Michael Troebs, Gerhard Heinzel,
      Measurement 39 (2006) 120-129.

 M Hewitson 02-02-07

 $Id: ltpda_lpsd.m,v 1.21 2008/08/10 20:16:49 hewitson Exp $

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % LTPDA_LPSD implement LPSD algorithm for analysis objects.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % LTPDA_LPSD implement LPSD algorithm for analysis objects.
0005 %
0006 %   >> bs = ltpda_lpsd(as)
0007 %
0008 %   Inputs:
0009 %     as  - array of analysis objects
0010 %     pl  - parameter list (see below)
0011 %
0012 %   Outputs:
0013 %     bs  - array of analysis objects, one for each input
0014 %
0015 %   Parameter list:
0016 %     Kdes  - desired number of averages   (default 100)
0017 %     Lmin  - minimum segment length   (default 0)
0018 %     Jdes  - number of spectral frequencies to compute (default fs/2)
0019 %     win   - a specwin window object
0020 %             Only the design parameters of the window object are used; the
0021 %             window is recomputed for each DFT length inside the lpsd_core
0022 %             algorithm.
0023 %     Olap - desired overlap percentage (default: taken from window)
0024 %     Order - order of detrending
0025 %             -1 - no detrending
0026 %              0 - subtract mean
0027 %              1 - subtract linear fit
0028 %              N - subtract fit of polynomial, order N
0029 %     Scale - Scaling of output. Choose from:
0030 %               AS  - Amplitude (linear) Spectrum
0031 %               ASD - Amplitude (linear) Spectral Density
0032 %               PS  - Power Spectrum
0033 %               PSD - Power Spectral Density [default]
0034 %
0035 % The following call returns a parameter list object that contains the
0036 % default parameter values:
0037 %
0038 % >> pl = ltpda_lpsd('Params')
0039 %
0040 % The following call returns a string that contains the routine CVS version:
0041 %
0042 % >> version = ltpda_lpsd('Version')
0043 %
0044 % The following call returns a string that contains the routine category:
0045 %
0046 % >> category = ltpda_lpsd('Category')
0047 %
0048 % References:
0049 %     "Improved spectrum estimation from digitized time series
0050 %      on a logarithmic frequency axis", Michael Troebs, Gerhard Heinzel,
0051 %      Measurement 39 (2006) 120-129.
0052 %
0053 % M Hewitson 02-02-07
0054 %
0055 % $Id: ltpda_lpsd.m,v 1.21 2008/08/10 20:16:49 hewitson Exp $
0056 %
0057 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0058 
0059 function varargout = ltpda_lpsd(varargin)
0060 
0061   warning('!!! This function is deprecated and will be removed from future versions of LTPDA. Use ao/lpsd now.');
0062 
0063   % Call ao/pwelch
0064   bs =  lpsd(varargin{:});
0065 
0066   % set output
0067   varargout{1} = bs;
0068 end
0069 % END

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