Home > m > sigproc > frequency_domain > ltpda_lcohere.m

ltpda_lcohere

PURPOSE ^

LTPDA_LCOHERE implement weighted coherence estimation computed on a log frequency axis.

SYNOPSIS ^

function varargout = ltpda_lcohere(varargin)

DESCRIPTION ^

 LTPDA_LCOHERE implement weighted coherence estimation computed on a log frequency axis.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 LTPDA_LCOHERE implement weighted cross-power estimation computed on a
 log frequency axis.

 Usage:
   >> txy = ltpda_lcohere(as)
   >> txy = ltpda_lcohere(as, pl)
   >> [txy, sig2] = ltpda_lcohere(as, pl)  % returns variance estimates

   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: 1000]
     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. [default: Kaiser with -200dB PSLL]
     Nolap - desired overlap [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

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

 >> pl = ltpda_lcohere('Params')


 M Hewitson 02-02-07

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

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % LTPDA_LCOHERE implement weighted coherence estimation computed on a log frequency axis.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % LTPDA_LCOHERE implement weighted cross-power estimation computed on a
0005 % log frequency axis.
0006 %
0007 % Usage:
0008 %   >> txy = ltpda_lcohere(as)
0009 %   >> txy = ltpda_lcohere(as, pl)
0010 %   >> [txy, sig2] = ltpda_lcohere(as, pl)  % returns variance estimates
0011 %
0012 %   Inputs:
0013 %     as  - array of analysis objects
0014 %     pl  - parameter list (see below)
0015 %
0016 %   Outputs:
0017 %     bs  - array of analysis objects, one for each input
0018 %
0019 %   Parameter list:
0020 %     Kdes  - desired number of averages   [default: 100]
0021 %     Lmin  - minimum segment length   [default: 0]
0022 %     Jdes  - number of spectral frequencies to compute [default: 1000]
0023 %     Win   - a specwin window object
0024 %             Only the design parameters of the window object are used; the
0025 %             window is recomputed for each DFT length inside the lpsd_core
0026 %             algorithm. [default: Kaiser with -200dB PSLL]
0027 %     Nolap - desired overlap [default: taken from window]
0028 %     Order - order of detrending.
0029 %             -1 - no detrending
0030 %              0 - subtract mean
0031 %              1 - subtract linear fit
0032 %              N - subtract fit of polynomial, order N
0033 %
0034 % The following call returns a parameter list object that contains the
0035 % default parameter values:
0036 %
0037 % >> pl = ltpda_lcohere('Params')
0038 %
0039 %
0040 % M Hewitson 02-02-07
0041 %
0042 % $Id: ltpda_lcohere.m,v 1.12 2008/08/10 20:16:49 hewitson Exp $
0043 %
0044 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0045 
0046 function varargout = ltpda_lcohere(varargin)
0047 
0048   warning('!!! This function is deprecated and will be removed from future versions of LTPDA. Use ao/lcohere now.');
0049 
0050   % Call ao/lcohere
0051   bs =  lcohere(varargin{:});
0052 
0053   % set output
0054   varargout{1} = bs;
0055 end
0056 % END

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