Home > m > sigproc > frequency_domain > ltpda_cpsd.m

ltpda_cpsd

PURPOSE ^

LTPDA_CPSD makes cross-spectral density estimates of the time-series objects.

SYNOPSIS ^

function varargout = ltpda_cpsd(varargin)

DESCRIPTION ^

 LTPDA_CPSD makes cross-spectral density estimates of the time-series objects.

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

 DESCRIPTION: LTPDA_CPSD makes cross-spectral density estimates of the
              time-series objects in the input analysis objects. CPSDs are computed
              using MATLAB's cpsd (>> help cpsd).

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

 INPUTS:      b    - output analysis objects
              aN   - input analysis objects (at least two)
              pl   - input parameter list

              The function makes CPSD estimates between all input AOs.
              Therefore, if the input argument list contains N analysis objects, the
              output a will contain NxN CPSD estimates.
              The diagonal elements will be S_ai_ai and will be equivalent to
              the output of ltpda_pwelch(ai)

              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]
             'Order' - order of segment detrending:
                        -1 - no detrending
                         0 - subtract mean [default]
                         1 - subtract linear fit
                         N - subtract fit of polynomial, order N

 VERSION:     $Id: ltpda_cpsd.m,v 1.12 2008/08/10 20:16:49 hewitson Exp $

 HISTORY:     07-02-2007 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % LTPDA_CPSD makes cross-spectral density estimates of the time-series objects.
0002 %
0003 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0004 %
0005 % DESCRIPTION: LTPDA_CPSD makes cross-spectral density estimates of the
0006 %              time-series objects in the input analysis objects. CPSDs are computed
0007 %              using MATLAB's cpsd (>> help cpsd).
0008 %
0009 % CALL:        b = ltpda_cpsd(a1,a2,a3,...,pl)
0010 %
0011 % INPUTS:      b    - output analysis objects
0012 %              aN   - input analysis objects (at least two)
0013 %              pl   - input parameter list
0014 %
0015 %              The function makes CPSD estimates between all input AOs.
0016 %              Therefore, if the input argument list contains N analysis objects, the
0017 %              output a will contain NxN CPSD estimates.
0018 %              The diagonal elements will be S_ai_ai and will be equivalent to
0019 %              the output of ltpda_pwelch(ai)
0020 %
0021 %              If the last input argument is a parameter list (plist) it is used. The
0022 %              following parameters are recognised.
0023 %
0024 % PARAMETERS: 'Win'   - a specwin window object [default: Kaiser -200dB psll]
0025 %             'Olap'  - segment percent overlap [default: taken from window function]
0026 %             'Nfft'  - number of samples in each fft [default: length of input data]
0027 %             'Order' - order of segment detrending:
0028 %                        -1 - no detrending
0029 %                         0 - subtract mean [default]
0030 %                         1 - subtract linear fit
0031 %                         N - subtract fit of polynomial, order N
0032 %
0033 % VERSION:     $Id: ltpda_cpsd.m,v 1.12 2008/08/10 20:16:49 hewitson Exp $
0034 %
0035 % HISTORY:     07-02-2007 M Hewitson
0036 %                 Creation
0037 %
0038 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0039 
0040 function varargout = ltpda_cpsd(varargin)
0041 
0042   warning('!!! This function is deprecated and will be removed from future versions of LTPDA. Use ao/cpsd now.');
0043 
0044   % Call ao/cpsd
0045   bs =  cpsd(varargin{:});
0046 
0047   % set output
0048   varargout{1} = bs;
0049 end

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