Home > classes > @ao > pwelch.m

pwelch

PURPOSE ^

PWELCH makes power spectral density estimates of the time-series objects

SYNOPSIS ^

function varargout = pwelch(varargin)

DESCRIPTION ^

 PWELCH makes power spectral density estimates of the time-series objects
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: PWELCH makes power spectral density estimates of the
              time-series objects in the input analysis objects.

 CALL:        b = pwelch(a1,a2,a3,...,pl)

 INPUTS:      b    - output analysis objects
              aN   - input analysis objects
              pl   - input parameter list

              Makes PSD estimates using psd() of each input AO.

              If the last input argument is a parameter list (plist) it is used.
              The following parameters are recognised.

 PARAMETERS: 'Win'   - a specwin window object [default: Kaiser -200dB psll]
             'Olap' - segment percent overlap [default: taken from window function]
             'Nfft'  - number of samples in each fft [default: length of input data]
                       A string value containing the variable 'fs' can
                       also be used, e.g., plist('Nfft', '2*fs')
             'Scale' - one of
                                'ASD' - amplitude spectral density
                                'PSD' - power spectral density [default]
                                'AS'  - amplitude spectrum
                                'PS'  - power spectrum
             'Order' - order of segment detrending
                        -1 - no detrending
                         0 - subtract mean [default]
                         1 - subtract linear fit
                         N - subtract fit of polynomial, order N

 M-FILE INFO: Get information about this methods by calling
              >> ao.getInfo('pwelch')

              Get information about a specified set-plist by calling:
              >> ao.getInfo('pwelch', 'None')

 VERSION:    $Id: pwelch.m,v 1.14 2008/08/07 13:00:39 ingo Exp $

 HISTORY:    07-02-2007 M Hewitson
                Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % PWELCH makes power spectral density estimates of the time-series objects
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: PWELCH makes power spectral density estimates of the
0005 %              time-series objects in the input analysis objects.
0006 %
0007 % CALL:        b = pwelch(a1,a2,a3,...,pl)
0008 %
0009 % INPUTS:      b    - output analysis objects
0010 %              aN   - input analysis objects
0011 %              pl   - input parameter list
0012 %
0013 %              Makes PSD estimates using psd() of each input AO.
0014 %
0015 %              If the last input argument is a parameter list (plist) it is used.
0016 %              The following parameters are recognised.
0017 %
0018 % PARAMETERS: 'Win'   - a specwin window object [default: Kaiser -200dB psll]
0019 %             'Olap' - segment percent overlap [default: taken from window function]
0020 %             'Nfft'  - number of samples in each fft [default: length of input data]
0021 %                       A string value containing the variable 'fs' can
0022 %                       also be used, e.g., plist('Nfft', '2*fs')
0023 %             'Scale' - one of
0024 %                                'ASD' - amplitude spectral density
0025 %                                'PSD' - power spectral density [default]
0026 %                                'AS'  - amplitude spectrum
0027 %                                'PS'  - power spectrum
0028 %             'Order' - order of segment detrending
0029 %                        -1 - no detrending
0030 %                         0 - subtract mean [default]
0031 %                         1 - subtract linear fit
0032 %                         N - subtract fit of polynomial, order N
0033 %
0034 % M-FILE INFO: Get information about this methods by calling
0035 %              >> ao.getInfo('pwelch')
0036 %
0037 %              Get information about a specified set-plist by calling:
0038 %              >> ao.getInfo('pwelch', 'None')
0039 %
0040 % VERSION:    $Id: pwelch.m,v 1.14 2008/08/07 13:00:39 ingo Exp $
0041 %
0042 % HISTORY:    07-02-2007 M Hewitson
0043 %                Creation
0044 %
0045 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0046 function varargout = pwelch(varargin)
0047   warning('! This method is deprecated and will be removed from future releases of the toolbox. Use ao/psd instead.')
0048   if nargout == 0
0049     psd(varargin{:})
0050   else
0051     varargout{:} = psd(varargin{:});
0052   end
0053 end
0054 
0055 % END
0056

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