Mercurial > hg > ltpda
diff m-toolbox/classes/@ao/cov.m @ 0:f0afece42f48
Import.
author | Daniele Nicolodi <nicolodi@science.unitn.it> |
---|---|
date | Wed, 23 Nov 2011 19:22:13 +0100 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/classes/@ao/cov.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,114 @@ +% COV estimate covariance of data streams. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: COV estimate covariance of data streams. +% +% CALL: c = cov(a,b, pl) +% +% INPUTS: pl - a parameter list +% a,b - input analysis object +% +% OUTPUTS: c - output analysis object containing the covariance matrix. +% +% <a href="matlab:utils.helper.displayMethodInfo('ao', 'cov')">Parameters Description</a> +% +% VERSION: $Id: cov.m,v 1.18 2011/04/08 08:56:12 hewitson Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function varargout = cov(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); + + % Collect input variable names + in_names = cell(size(varargin)); + for ii = 1:nargin,in_names{ii} = inputname(ii);end + + % Collect all AOs and plists + [as, ao_invars] = utils.helper.collect_objects(varargin(:), 'ao', in_names); + + if nargout == 0 + error('### cov cannot be used as a modifier. Please give an output variable.'); + end + + if numel(as) < 2 + error('### cov requires at least two input AOs to work.'); + end + + % Convolute the data + smat = []; + inunits = unit; + name = ''; + desc = ''; + for jj=1:numel(as) + smat = [smat as(jj).data.getY]; + inunits = inunits .* as(jj).data.yunits; + name = strcat(name, [',' ao_invars{jj}]); + desc = strcat(desc, [' ' as(jj).description]); + end + desc = strtrim(desc); + plotinfo = [as(:).plotinfo]; + if ~isempty(plotinfo) + plotinfo = combine(plotinfo); + end + + bs = ao(cdata(cov(smat))); + bs.name = sprintf('cov(%s)', name(2:end)); + bs.description = desc; + bs.plotinfo = plotinfo; + bs.data.setYunits(inunits); + bs.addHistory(getInfo('None'), getDefaultPlist, ao_invars, [as(:).hist]); + + % Set output + if nargout == numel(bs) + % List of outputs + for ii = 1:numel(bs) + varargout{ii} = bs(ii); + end + else + % Single output + varargout{1} = bs; + end +end + +%-------------------------------------------------------------------------- +% Get Info Object +%-------------------------------------------------------------------------- +function ii = getInfo(varargin) + if nargin == 1 && strcmpi(varargin{1}, 'None') + sets = {}; + pls = []; + else + sets = {'Default'}; + pls = getDefaultPlist; + end + % Build info object + ii = minfo(mfilename, 'ao', 'ltpda', utils.const.categories.sigproc, '$Id: cov.m,v 1.18 2011/04/08 08:56:12 hewitson Exp $', sets, pls); + ii.setModifier(false); + ii.setArgsmin(2); +end + +%-------------------------------------------------------------------------- +% Get Default Plist +%-------------------------------------------------------------------------- + + +function plout = getDefaultPlist() + persistent pl; + if exist('pl', 'var')==0 || isempty(pl) + pl = buildplist(); + end + plout = pl; +end + +function pl_default = buildplist() + pl_default = plist.EMPTY_PLIST; +end +