Home > m > sigproc > frequency_domain > ltpda_tfe.m

ltpda_tfe

PURPOSE ^

LTPDA_TFE makes transfer function estimates of the time-series objects.

SYNOPSIS ^

function varargout = ltpda_tfe(varargin)

DESCRIPTION ^

 LTPDA_TFE makes transfer function estimates of the time-series objects.

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

 DESCRIPTION: LTPDA_TFE makes transfer function estimates of the time-series
              objects in the input analysis objects. Transfer functions are
              computed using MATLAB's tfestimate (>> help tfestimate).

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

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

 OUTPUTS:    The output matrix b contains NxN transfer functions estimates (all
             possible pairs of input AOs).

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

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

 HISTORY:    07-02-2007 M Hewitson
                Creation

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

 >> pl = ltpda_tfe('Params')

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

 >> version = ltpda_tfe('Version')

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

 >> category = ltpda_tfe('Category')

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % LTPDA_TFE makes transfer function estimates of the time-series objects.
0002 %
0003 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0004 %
0005 % DESCRIPTION: LTPDA_TFE makes transfer function estimates of the time-series
0006 %              objects in the input analysis objects. Transfer functions are
0007 %              computed using MATLAB's tfestimate (>> help tfestimate).
0008 %
0009 % CALL:       b = ltpda_tfe(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 % OUTPUTS:    The output matrix b contains NxN transfer functions estimates (all
0016 %             possible pairs of input AOs).
0017 %
0018 %             If the last input argument is a parameter list (plist) it is used.
0019 %             The following parameters are recognised.
0020 %
0021 % PARAMETERS: 'Win'   - a specwin window object [default: Kaiser -200dB psll]
0022 %             'Olap'  - segment percent overlap [default: taken from window function]
0023 %             'Nfft'  - number of samples in each fft [default: length of input data]
0024 %              Order - order of detrending:
0025 %                      -1 - no detrending
0026 %                       0 - subtract mean [default]
0027 %                       1 - subtract linear fit
0028 %                       N - subtract fit of polynomial, order N
0029 %
0030 % VERSION:    $Id: ltpda_tfe.m,v 1.18 2008/08/10 20:16:49 hewitson Exp $
0031 %
0032 % HISTORY:    07-02-2007 M Hewitson
0033 %                Creation
0034 %
0035 % The following call returns a parameter list object that contains the
0036 % default parameter values:
0037 %
0038 % >> pl = ltpda_tfe('Params')
0039 %
0040 % The following call returns a string that contains the routine CVS version:
0041 %
0042 % >> version = ltpda_tfe('Version')
0043 %
0044 % The following call returns a string that contains the routine category:
0045 %
0046 % >> category = ltpda_tfe('Category')
0047 %
0048 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0049 
0050 function varargout = ltpda_tfe(varargin)
0051 
0052   warning('!!! This function is deprecated and will be removed from future versions of LTPDA. Use ao/tfe now.');
0053 
0054 
0055   % Call ao/tfe
0056   bs =  tfe(varargin{:});
0057 
0058   % set output
0059   varargout{1} = bs;
0060 end

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