Mercurial > hg > ltpda
diff m-toolbox/classes/@ao/cpsd.m @ 0:f0afece42f48
Import.
author | Daniele Nicolodi <nicolodi@science.unitn.it> |
---|---|
date | Wed, 23 Nov 2011 19:22:13 +0100 |
parents | |
children | bc767aaa99a8 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/classes/@ao/cpsd.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,94 @@ +% CPSD estimates the cross-spectral density between time-series objects +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: CPSD estimates the cross-spectral density between the +% time-series objects in the input analysis objects. CPSD is computed +% using a modified version of MATLAB's cpsd (>> help cpsd). +% +% CALL: b = cpsd(a1,a2,pl) +% +% INPUTS: aN - input analysis objects (two) +% pl - input parameter list +% +% OUTPUTS: b - output analysis object +% +% <a href="matlab:utils.helper.displayMethodInfo('ao', 'cpsd')">Parameters Description</a> +% +% VERSION: $Id: cpsd.m,v 1.38 2011/04/08 08:56:13 hewitson Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function varargout = cpsd(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('### cpsd 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('### cpsd only accepts two inputs AOs.'); + end + + % Compute cross-spectrum with xspec + bs = xspec(as, pl, 'cpsd', 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: cpsd.m,v 1.38 2011/04/08 08:56:13 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, linearly spaced spectral estimators + pl = plist.WELCH_PLIST; + +end +