Mercurial > hg > ltpda
diff m-toolbox/classes/@smodel/setTrans.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/@smodel/setTrans.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,138 @@ +% SETTRANS sets the 'trans' property of the smodel object. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: SETTRANS sets the 'trans' property of the smodel object. +% +% CALL: objs.setTrans(val); +% objs.setTrans(val1, val2); +% objs.setTrans(plist('trans', val)); +% objs = objs.setTrans(val); +% +% INPUTS: objs: Can be a vector, matrix, list, or a mix of them. +% val: Can be any of the following types: +% - string e.g. 'x1' +% - numeric values e.g. 1 +% - plist with the key 'trans' e.g. plist('trans', {'x1', 'x2'}) +% - cell-array with the types above +% +% REMARK: The 'trans' property can be a matlab express which will be +% evalulated, or a numeric value. It is meant to specify a +% scale factor between the user-specified x-values and the +% user-specified x-variable. +% +% <a href="matlab:utils.helper.displayMethodInfo('smodel', 'setTrans')">Parameters Description</a> +% +% VERSION: $Id: setTrans.m,v 1.11 2011/04/28 19:50:57 mauro Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function varargout = setTrans(varargin) + + % Check if this is a call from a class method + callerIsMethod = utils.helper.callerIsMethod; + + if callerIsMethod + sm = varargin{1}; + values = varargin(2:end); + + else + % 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 smodel objects + [sm, sm_invars, rest] = utils.helper.collect_objects(varargin(:), 'smodel', in_names); + pls = utils.helper.collect_objects(rest(:), 'plist'); + + % Combine input plists and default PLIST + pls = combine(pls, getDefaultPlist()); + + % Get values for the smodel objects + values = processValues({}, rest); + + end % callerIsMethod + + % Decide on a deep copy or a modify + sm = copy(sm, nargout); + + % Loop over smodel objects + for jj = 1:numel(sm) + sm(jj).trans = values; + if ~callerIsMethod + plh = pls.pset('trans', values); + sm(jj).addHistory(getInfo('None'), plh, sm_invars(jj), sm(jj).hist); + end + end + + % Set output + varargout = utils.helper.setoutputs(nargout, sm); +end + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Local Functions % +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function values = processValues(values, rest) + if ~isempty(rest) + switch class(rest) + case 'cell' + if iscellstr(rest) + values = [values rest]; + else + for ii = 1:numel(rest); + values = processValues(values, rest{ii}); + end + end + case 'double' + values = [values {num2str(rest)}]; + case 'char' + values = [values {rest}]; + case 'plist' + if length(rest) == 1 && isa(rest, 'plist') && isparam(rest, 'trans') + vals = find(rest, 'trans'); + values = processValues(values, vals); + end + otherwise + end + end +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, mfilename('class'), 'ltpda', utils.const.categories.helper, '$Id: setTrans.m,v 1.11 2011/04/28 19:50:57 mauro Exp $', sets, pl); +end + +%-------------------------------------------------------------------------- +% Get Default Plist +%-------------------------------------------------------------------------- +function plout = getDefaultPlist() + persistent pl; + if ~exist('pl', 'var') || isempty(pl) + pl = buildplist(); + end + plout = pl; +end + +function pl = buildplist() + pl = plist({'trans', 'Specify the transformation scale-factor between the x-values and the x-variable.'}, paramValue.EMPTY_CELL); +end