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: fs of input data]

 VERSION:    $Id: ltpda_tfe.html,v 1.13 2008/03/26 18:02:09 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:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function varargout = ltpda_tfe(varargin)
0002 % LTPDA_TFE makes transfer function estimates of the time-series objects.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: LTPDA_TFE makes transfer function estimates of the time-series
0007 %              objects in the input analysis objects. Transfer functions are
0008 %              computed using MATLAB's tfestimate (>> help tfestimate).
0009 %
0010 % CALL:       b = ltpda_tfe(a1,a2,a3,...,pl)
0011 %
0012 % INPUTS:     b    - output analysis objects
0013 %             aN   - input analysis objects (at least two)
0014 %             pl   - input parameter list
0015 %
0016 % OUTPUTS:    The output matrix b contains NxN transfer functions estimates (all
0017 %             possible pairs of input AOs).
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: fs of input data]
0025 %
0026 % VERSION:    $Id: ltpda_tfe.html,v 1.13 2008/03/26 18:02:09 hewitson Exp $
0027 %
0028 % HISTORY:    07-02-2007 M Hewitson
0029 %                Creation
0030 %
0031 % The following call returns a parameter list object that contains the
0032 % default parameter values:
0033 %
0034 % >> pl = ltpda_tfe('Params')
0035 %
0036 % The following call returns a string that contains the routine CVS version:
0037 %
0038 % >> version = ltpda_tfe('Version')
0039 %
0040 % The following call returns a string that contains the routine category:
0041 %
0042 % >> category = ltpda_tfe('Category')
0043 %
0044 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0045 
0046 ALGONAME = mfilename;
0047 VERSION  = '$Id: ltpda_tfe.html,v 1.13 2008/03/26 18:02:09 hewitson Exp $';
0048 CATEGORY = 'Signal Processing';
0049 
0050 
0051 %% Check if this is a call for parameters, the CVS version string
0052 % or the function category
0053 if nargin == 1 && ischar(varargin{1})
0054   in = char(varargin{1});
0055   if strcmp(in, 'Params')
0056     varargout{1} = getDefaultPL();
0057     return
0058   elseif strcmp(in, 'Version')
0059     varargout{1} = VERSION;
0060     return
0061   elseif strcmp(in, 'Category')
0062     varargout{1} = CATEGORY;
0063     return
0064   end
0065 end
0066 
0067 % capture input variable names
0068 invars = {};
0069 as     = [];
0070 ps     = [];
0071 for j=1:nargin
0072   invars = [invars cellstr(inputname(j))];
0073   if isa(varargin{j}, 'ao')
0074     as = [as varargin{j}];
0075   end
0076   if isa(varargin{j}, 'plist')
0077     ps = [ps varargin{j}];
0078   end
0079 end
0080 
0081 
0082 % check plist
0083 if isempty(ps)
0084   pl = getDefaultPL();
0085 else
0086   pl = combine(ps, getDefaultPL);
0087 end
0088 
0089 varargout{1} = ltpda_xspec(as, pl, 'TF', ALGONAME, VERSION, invars);
0090 
0091 
0092 
0093 
0094 
0095 %--------------------------------------------------------------------------
0096 % Get default params
0097 function plo = getDefaultPL()
0098 
0099 disp('* creating default plist...');
0100 plo = plist('Nfft', -1, ...
0101   'Win', specwin('Kaiser', 1, 100),...
0102   'Olap', -1);
0103 
0104 disp('* done.');
0105

Generated on Tue 25-Mar-2008 23:00:00 by m2html © 2003