Home > classes > @ao > ltfe.m

ltfe

PURPOSE ^

LTFE implement transfer-function estimation computed on a log frequency axis.

SYNOPSIS ^

function varargout = ltfe(varargin)

DESCRIPTION ^

 LTFE implement transfer-function estimation computed on a log frequency axis.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: LTFE implement transfer-function estimation computed on a
              log frequency axis.

 CALL:        tfs = ltfe(as)
              tfs = ltfe(as, pl)

 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: fs/4]
              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 ltpda_dft
             algorithm. [default: Kaiser with -200dB PSLL]
              Olap  - 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

 M-FILE INFO: Get information about this methods by calling
              >> ao.getInfo('ltfe')

              Get information about a specified set-plist by calling:
              >> ao.getInfo('ltfe', 'None')

 VERSION:     $Id: ltfe.m,v 1.6 2008/09/05 11:05:29 ingo Exp $

 HISTORY:     02-02-2007 M Hewitson
                 Created

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % LTFE implement transfer-function estimation computed on a log frequency axis.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: LTFE implement transfer-function estimation computed on a
0005 %              log frequency axis.
0006 %
0007 % CALL:        tfs = ltfe(as)
0008 %              tfs = ltfe(as, pl)
0009 %
0010 % INPUTS:      as  - array of analysis objects
0011 %              pl  - parameter list (see below)
0012 %
0013 % OUTPUTS:     bs  - array of analysis objects, one for each input
0014 %
0015 % PARAMETER LIST:
0016 %
0017 %              Kdes  - desired number of averages   [default: 100]
0018 %              Lmin  - minimum segment length   [default: 0]
0019 %              Jdes  - number of spectral frequencies to compute [default: fs/4]
0020 %              Win   - a specwin window object
0021 %                      Only the design parameters of the window object are used; the
0022 %                      window is recomputed for each DFT length inside the ltpda_dft
0023 %             algorithm. [default: Kaiser with -200dB PSLL]
0024 %              Olap  - desired overlap [default: taken from window]
0025 %              Order - order of detrending.
0026 %                      -1 - no detrending
0027 %                       0 - subtract mean
0028 %                       1 - subtract linear fit
0029 %                       N - subtract fit of polynomial, order N
0030 %
0031 % M-FILE INFO: Get information about this methods by calling
0032 %              >> ao.getInfo('ltfe')
0033 %
0034 %              Get information about a specified set-plist by calling:
0035 %              >> ao.getInfo('ltfe', 'None')
0036 %
0037 % VERSION:     $Id: ltfe.m,v 1.6 2008/09/05 11:05:29 ingo Exp $
0038 %
0039 % HISTORY:     02-02-2007 M Hewitson
0040 %                 Created
0041 %
0042 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0043 
0044 function varargout = ltfe(varargin)
0045 
0046   % Check if this is a call for parameters
0047   if utils.helper.isinfocall(varargin{:})
0048     varargout{1} = getInfo(varargin{3});
0049     return
0050   end
0051 
0052   import utils.const.*
0053   utils.helper.msg(msg.MNAME, 'running %s/%s', mfilename('class'), mfilename);
0054   
0055   % Collect input variable names
0056   in_names = cell(size(varargin));
0057   for ii = 1:nargin,in_names{ii} = inputname(ii);end
0058 
0059   % Collect all AOs and plists
0060   [as, ao_invars] = utils.helper.collect_objects(varargin(:), 'ao', in_names);
0061   pl              = utils.helper.collect_objects(varargin(:), 'plist', in_names);
0062 
0063   % Combine plists
0064   pl = combine(pl, getDefaultPlist);
0065 
0066   % Compute coherence with lxspec
0067   varargout{1} = ao.lxspec(as, pl, 'tfe', getInfo, ao_invars);
0068 end
0069 
0070 %--------------------------------------------------------------------------
0071 % Get Info Object
0072 %--------------------------------------------------------------------------
0073 function ii = getInfo(varargin)
0074   if nargin == 1 && strcmpi(varargin{1}, 'None')
0075     sets = {};
0076     pl   = [];
0077   else
0078     sets = {'Default'};
0079     pl   = getDefaultPlist;
0080   end
0081   % Build info object
0082   ii = minfo(mfilename, 'ao', '', utils.const.categories.sigproc, '$Id: ltfe.m,v 1.6 2008/09/05 11:05:29 ingo Exp $', sets, pl);
0083 end
0084 
0085 %--------------------------------------------------------------------------
0086 % Get Default Plist
0087 %--------------------------------------------------------------------------
0088 function pl = getDefaultPlist()
0089   pl = plist(...
0090     'Kdes', 100,...
0091     'Jdes', 1000,...
0092     'Lmin', 0,...
0093     'Win',  getappdata(0, 'ltpda_default_spectral_window'), ...
0094     'Olap', -1,...
0095     'Order', 0);
0096 end
0097 % END

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