view m-toolbox/classes/@ao/ltfe.m @ 13:e05504b18072
database-connection-manager
Move more functions to utils.repository
author
Daniele Nicolodi <nicolodi@science.unitn.it>
date
Mon, 05 Dec 2011 16:20:06 +0100 (2011-12-05)
parents
f0afece42f48
children
line source
+ − % LTFE implements transfer function estimation computed on a log frequency axis.
+ − %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+ − %
+ − % DESCRIPTION: LTFE implements transfer function estimation computed on a
+ − % log frequency axis. The estimate is done by taking
+ − % the ratio of the CPSD between the two inputs, Sxy, divided by
+ − % the PSD of the first input, Sxx:
+ − % Sxy / Sxx where x is the first input, y is the second input
+ − %
+ − % CALL: b = ltfe(a1,a2,pl)
+ − %
+ − % INPUTS: a1 - input analysis object
+ − % a2 - input analysis object
+ − % pl - input parameter list
+ − %
+ − % OUTPUTS: b - output analysis object
+ − %
+ − % <a href="matlab:utils.helper.displayMethodInfo('ao', 'ltfe')">Parameters Description</a>
+ − %
+ − % VERSION: $Id: ltfe.m,v 1.29 2011/04/08 08:56:16 hewitson Exp $
+ − %
+ − % References: "Improved spectrum estimation from digitized time series
+ − % on a logarithmic frequency axis", Michael Troebs, Gerhard Heinzel,
+ − % Measurement 39 (2006) 120-129.
+ − %
+ − %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+ −
+ − function varargout = ltfe(varargin)
+ −
+ − % Check if this is a call for parameters
+ − if utils.helper.isinfocall(varargin{:})
+ − varargout{1} = getInfo(varargin{3});
+ − return
+ − end
+ −
+ − import utils.const.*
+ − utils.helper.msg(msg.PROC3, 'running %s/%s', mfilename('class'), mfilename);
+ −
+ − if nargout == 0
+ − error('### tfe cannot be used as a modifier. Please give an output variable.');
+ − end
+ −
+ − % Collect input variable names
+ − in_names = cell(size(varargin));
+ − for ii = 1:nargin,in_names{ii} = inputname(ii);end
+ −
+ − % Collect all AOs
+ − [as, ao_invars] = utils.helper.collect_objects(varargin(:), 'ao', in_names);
+ −
+ − % Apply defaults to plist
+ − pl = applyDefaults(getDefaultPlist, varargin{:});
+ −
+ − % Throw an error if input is not two AOs
+ − if numel(as) ~= 2
+ − error('### ltfe only accepts two inputs AOs.');
+ − end
+ −
+ − % Compute transfer function with lxspec
+ − bs = ao.lxspec(as, pl, 'tfe', getInfo, ao_invars);
+ −
+ − % Set output
+ − varargout{1} = bs;
+ −
+ − end
+ −
+ − %--------------------------------------------------------------------------
+ − % Get Info Object
+ − %--------------------------------------------------------------------------
+ − function ii = getInfo(varargin)
+ − if nargin == 1 && strcmpi(varargin{1}, 'None')
+ − sets = {};
+ − pl = [];
+ − else
+ − sets = {'Default'};
+ − pl = getDefaultPlist();
+ − end
+ − % Build info object
+ − ii = minfo(mfilename, 'ao', 'ltpda', utils.const.categories.sigproc, '$Id: ltfe.m,v 1.29 2011/04/08 08:56:16 hewitson Exp $', sets, pl);
+ − ii.setModifier(false);
+ − ii.setArgsmin(2);
+ − end
+ −
+ − %--------------------------------------------------------------------------
+ − % Get Default Plist
+ − %--------------------------------------------------------------------------
+ − function plout = getDefaultPlist()
+ − persistent pl;
+ − if ~exist('pl', 'var') || isempty(pl)
+ − pl = buildplist();
+ − end
+ − plout = pl;
+ − end
+ −
+ − function pl = buildplist()
+ −
+ − % General plist for Welch-based, log-scale spaced spectral estimators
+ − pl = plist.LPSD_PLIST;
+ −
+ − end
+ −
+ −
+ − % PARAMETERS:
+ − %
+ − % 'Kdes' - desired number of averages [default: 100]
+ − % 'Jdes' - number of spectral frequencies to compute [default: 1000]
+ − % 'Lmin' - minimum segment length [default: 0]
+ − % 'Win' - the window to be applied to the data to remove the
+ − % discontinuities at edges of segments. [default: taken from
+ − % user prefs]
+ − % Only the design parameters of the window object are
+ − % used. Enter either:
+ − % - a specwin window object OR
+ − % - a string value containing the window name
+ − % e.g., plist('Win', 'Kaiser', 'psll', 200)
+ − % 'Olap' - segment percent overlap [default: -1, (taken from window function)]
+ − % 'Order' - order of segment detrending
+ − % -1 - no detrending
+ − % 0 - subtract mean [default]
+ − % 1 - subtract linear fit
+ − % N - subtract fit of polynomial, order N
+ − % 'Variance' - computes transfer function variance.
+ − % 'yes' - compute tf variance [default]
+ − % 'no' - do not compute tf variance