diff m-toolbox/classes/@pest/find.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/@pest/find.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,155 @@
+% FIND Creates analysis objects from the selected parameter(s).
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: FIND Creates analysis objects from the selected
+%              parameter(s).
+%
+% CALL:        obj = obj.find();
+%              obj = obj.find('a');
+%              obj = obj.find('a', 'b');
+%              obj = obj.find(plist('params', {'a', 'b'}))
+%
+% INPUTS:      obj - one pest model.
+%              pl  - parameter list
+%
+% <a href="matlab:utils.helper.displayMethodInfo('pest', 'find')">Parameters Description</a>
+%
+% VERSION:     $Id: find.m,v 1.7 2011/04/08 08:56:25 hewitson Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function varargout = find(varargin)
+  
+  % Check if this is a call for parameters
+  if utils.helper.isinfocall(varargin{:})
+    varargout{1} = getInfo(varargin{3});
+    return
+  end
+  
+  %%% Collect input variable names
+  in_names = cell(size(varargin));
+  for ii = 1:nargin,in_names{ii} = inputname(ii);end
+  
+  [objs, obj_invars, rest] = utils.helper.collect_objects(varargin(:), 'pest', in_names);
+  [pls,  invars, rest]     = utils.helper.collect_objects(rest(:), 'plist');
+  
+  inParams = {};
+  out      = [];
+  %%% If pls contains only one plist with the key 'params' then set the
+  %%% property with a plist.
+  if length(pls) == 1 && isa(pls, 'plist') && pls.nparams == 1 && pls.isparam('params')
+    inParams = cellstr(find(pls, 'params'));
+  end
+  
+  if ~iscellstr(rest)
+    error('### Can not handle the input: %s', utils.helper.val2str(rest));
+  end
+  
+  inParams = [inParams rest];
+  
+  for objLoop = 1:numel(objs)
+    
+    %%% decide whether we modify the input pest object, or create a new one.
+    objs(objLoop) = copy(objs(objLoop), nargout);
+    
+    %%% Create from each parameter an AO if the user doesn't specify a
+    %%% parameter name.
+    if isempty(inParams)
+      params = objs(objLoop).names;
+    else
+      params = inParams;
+    end
+    
+    for ll=1:numel(params)
+      pname = params{ll};
+      % get index of this param
+      idx = find(strcmp(objs(objLoop).names, pname), 1);
+      if isempty(idx)
+        % Do nothing because it is not possible to create an AO from a not
+        % existing parameter name.
+      else
+        a = ao(objs(objLoop).y(idx));
+        a.setName(pname);
+        if ~isempty(objs(objLoop).dy)
+          a.setDy(objs(objLoop).dy(idx));
+        end
+        if ~isempty(objs(objLoop).yunits)
+          a.setYunits(objs(objLoop).yunits(idx));
+        end
+        if numel(objs(objLoop).models) > 1
+          a.setProcinfo(plist('model', objs(objLoop).models(idx)));
+        else
+          a.setProcinfo(plist('model', objs(objLoop).models));
+        end
+        if ~strcmp(varargin{end}, 'internal')
+          a.addHistory(pest.getInfo('find', 'None'), plist('params', pname), obj_invars(objLoop), objs(objLoop).hist);
+        end
+        out = [out a];
+      end
+    end
+    
+  end
+  
+  %%% Set output
+  if nargout == numel(out)
+    % List of outputs
+    for ii = 1:numel(out)
+      varargout{ii} = out(ii);
+    end
+  else
+    % Single output
+    varargout{1} = out;
+  end
+  
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%                               Local Functions                               %
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getInfo
+%
+% DESCRIPTION: 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, 'pest', 'ltpda', utils.const.categories.helper, '$Id: find.m,v 1.7 2011/04/08 08:56:25 hewitson Exp $', sets, pl);
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getDefaultPlist
+%
+% DESCRIPTION: 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();
+  
+  % Params
+  p = param({'params', 'A cell-array of parameter names.'}, {1, {'{}'}, paramValue.OPTIONAL});
+  pl.append(p);
+
+end
+