Home > m > sigproc > frequency_domain > ltpda_cohere.m

ltpda_cohere

PURPOSE ^

LTPDA_COHERE makes coherence estimates of the time-series objects

SYNOPSIS ^

function varargout = ltpda_cohere(varargin)

DESCRIPTION ^

 LTPDA_COHERE makes coherence estimates of the time-series objects

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

 DESCRIPTION: LTPDA_COHERE makes coherence estimates of the time-series objects
              in the input analysis objects. Coherences are computed using
              MATLAB's mscohere (>> help mscohere).

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

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

              The function makes coherence estimates between all
              input AOs. Therefore, if the input argument list contains N
              analysis objects, the output, b, will contain NXN coherence estimates.

              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: half length of input data]
              Order - order of detrending.
                      -1 - no detrending
                       0 - subtract mean [default]
                       1 - subtract linear fit
                       N - subtract fit of polynomial, order N


 VERSION:    $Id: ltpda_cohere.m,v 1.14 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_COHERE makes coherence estimates of the time-series objects
0002 %
0003 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0004 %
0005 % DESCRIPTION: LTPDA_COHERE makes coherence estimates of the time-series objects
0006 %              in the input analysis objects. Coherences are computed using
0007 %              MATLAB's mscohere (>> help mscohere).
0008 %
0009 % CALL:        b = ltpda_cohere(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 coherence estimates between all
0016 %              input AOs. Therefore, if the input argument list contains N
0017 %              analysis objects, the output, b, will contain NXN coherence estimates.
0018 %
0019 %              If the last input argument is a parameter list (plist) it is used.
0020 %              The following parameters are recognised.
0021 %
0022 % PARAMETERS:  Win   - a specwin window object [default: Kaiser -200dB psll]
0023 %              Olap  - segment percent overlap [default: taken from window function]
0024 %              Nfft  - number of samples in each fft [default: half length of input data]
0025 %              Order - order of detrending.
0026 %                      -1 - no detrending
0027 %                       0 - subtract mean [default]
0028 %                       1 - subtract linear fit
0029 %                       N - subtract fit of polynomial, order N
0030 %
0031 %
0032 % VERSION:    $Id: ltpda_cohere.m,v 1.14 2008/08/10 20:16:49 hewitson Exp $
0033 %
0034 % HISTORY:    07-02-2007 M Hewitson
0035 %                Creation
0036 %
0037 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0038 
0039 function varargout = ltpda_cohere(varargin)
0040   warning('!!! This function is deprecated and will be removed from future versions of LTPDA. Use ao/cohere now.');
0041 
0042   % Call ao/cohere
0043   bs =  cohere(varargin{:});
0044 
0045   % set output
0046   varargout{1} = bs;
0047 end

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