Home > classes > @ao > mrdivide.m

mrdivide

PURPOSE ^

MRDIVIDE overloads / operator for analysis objects.

SYNOPSIS ^

function b = mrdivide(varargin)

DESCRIPTION ^

 MRDIVIDE overloads / operator for analysis objects.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: MRDIVIDE overloads / operator for analysis objects.

 CALL:        a = a1/scalar
              a = a1/a2

 VERSION:     $Id: mrdivide.m,v 1.9 2007/06/22 08:32:49 ingo Exp $

 The following call returns a parameter list object that contains the
 default parameter values:

 >> pl = mrdivide(ao, 'Params')

 HISTORY: 05-02-07 M Hewitson
             Creation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function b = mrdivide(varargin)
0002 % MRDIVIDE overloads / operator for analysis objects.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: MRDIVIDE overloads / operator for analysis objects.
0007 %
0008 % CALL:        a = a1/scalar
0009 %              a = a1/a2
0010 %
0011 % VERSION:     $Id: mrdivide.m,v 1.9 2007/06/22 08:32:49 ingo Exp $
0012 %
0013 % The following call returns a parameter list object that contains the
0014 % default parameter values:
0015 %
0016 % >> pl = mrdivide(ao, 'Params')
0017 %
0018 % HISTORY: 05-02-07 M Hewitson
0019 %             Creation
0020 %
0021 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0022 
0023 %% Check if this is a call for parameters
0024 if nargin == 2
0025   if isa(varargin{1}, 'ao') && ischar(varargin{2})
0026     in = char(varargin{2});
0027     if strcmp(in, 'Params')
0028       b = getDefaultPL();
0029       return
0030     end
0031   end
0032 end
0033 
0034 %% capture input variable names
0035 invars = {};
0036 for j=1:nargin
0037   iname = inputname(j);
0038   if isempty(iname) && isnumeric(varargin{j})
0039     iname = num2str(varargin{j});
0040   elseif isempty(iname) && ischar(varargin{j})
0041     iname = varargin{j};
0042   end
0043   invars = [invars cellstr(iname)];
0044 end
0045 
0046 ALGONAME = mfilename;
0047 VERSION  = '$Id: mrdivide.m,v 1.9 2007/06/22 08:32:49 ingo Exp $';
0048 
0049 op = '/';
0050 
0051 [a1,a2,do] = aooperate(varargin, op);
0052 
0053 %--------- create output AO
0054 
0055 % make a new history object
0056 h = history(ALGONAME, VERSION, [], [a1.hist a2.hist]);
0057 h = set(h, 'invars', invars);
0058 
0059 % get names for output
0060 if isempty(char(invars{1}))
0061   n1 = a1.name;
0062 else
0063   n1 = char(invars{1});
0064 end
0065 if isempty(char(invars{2}))
0066   n2 = a2.name;
0067 else
0068   n2 = char(invars{2});
0069 end
0070 
0071 % make output analysis object
0072 % op = op(2:end);
0073 b = ao(do, h);
0074 b = set(b, 'name', sprintf('%s %s %s', n1, op, n2));
0075 
0076 %% Get default params
0077 function pl_default = getDefaultPL()
0078 
0079 disp('* creating default plist...');
0080   pl_default = plist();
0081 disp('* done.');
0082 
0083 
0084 % END

Generated on Mon 03-Sep-2007 12:12:34 by m2html © 2003