Mercurial > hg > ltpda
diff m-toolbox/classes/@ao/scatterData.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/scatterData.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,119 @@ +% SCATTERDATA Creates from the y-values of two input AOs an new AO(xydata) +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: SCATTERDATA This method creates from the y-values of the +% input AOs a new AO with xydata. The y-values of the first +% input will be the x-values of the new AO and the y-values of +% the second AO will be the y-values of the new AO. +% +% CALL: b = scatterData(a1, a2, pl) +% +% INPUTS: aN - input analysis objects (two) +% pl - input parameter list +% +% OUTPUTS: b - output analysis object +% +% Possible actions: +% +% <a href="matlab:utils.helper.displayMethodInfo('ao', 'scatterData')">Parameters Description</a> +% +% VERSION: $Id: scatterData.m,v 1.8 2011/04/08 08:56:16 hewitson Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function varargout = scatterData(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 + [as, ao_invars,rest] = utils.helper.collect_objects(varargin(:), 'ao', in_names); + [pls, invars, rest] = utils.helper.collect_objects(rest(:), 'plist'); + + %%% Combine plists + pl = combine(pls, getDefaultPlist); + + % Check number of input AOs + if numel(as) ~= 2 + error('### This method can only handle two input AOs'); + end + + % Check the length of both AOs + if (len(as(1)) ~= len(as(2))) + error('### The length of both input AOs must be the same'); + end + + a1 = as(1); + a2 = as(2); + + xy = xydata(); + xy.setY(a2.y); + xy.setDy(a2.dy); + xy.setYunits(a2.yunits); + xy.setX(a1.y); + xy.setDx(a1.dy); + xy.setXunits(a1.yunits); + + bs = ao(xy); + bs.name = sprintf('scatterData(%s, %s)', a1.name, a2.name); + bs.description = [a1.description, ' ', a2.description]; + + bs.addHistory(getInfo('None'), pl, ao_invars, [a1.hist a2.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 + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Local Functions % +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%-------------------------------------------------------------------------- +% 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.helper, '$Id: scatterData.m,v 1.8 2011/04/08 08:56:16 hewitson Exp $', sets, pl); +end + +%-------------------------------------------------------------------------- +% Get Default Plist +%-------------------------------------------------------------------------- +function plout = getDefaultPlist() + persistent pl; + if exist('pl', 'var')==0 || isempty(pl) + pl = buildplist(); + end + plout = pl; +end + +function pl = buildplist() + pl = plist.EMPTY_PLIST; +end +