Home > classes > @ao > sum.m

sum

PURPOSE ^

SUM overloads the sum operator for Analysis objects. Compute the sum value.

SYNOPSIS ^

function ao_out = sum (varargin)

DESCRIPTION ^

 SUM overloads the sum operator for Analysis objects. Compute the sum value.

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

 DESCRIPTION: SUM overloads the sum operator for Analysis objects.
              Compute the sum value.
              SUM(ao) is the sum value of the elements in ao.data.

 CALL: ao_out = sum(ao_in);
       ao_out = sum(ao_in, dim);
       ao_out = sum(ao_in, pl);
       ao_out = sum(ao1, pl1, ao_vector, ao_matrix, pl2);

 POSSIBLE VALUES: ao_in  = [ao2 ao3]
                  ao_in  = ao_vector
                  ao_in  = ao_matrix

 PARAMETER LIST:  <key>           <value>             <description>
                  'dim'          1 or 2 or 3 ...    takes the sum along the
                                                    dimension dim
                          tsdata  fsdata  xydata
                 'xdata'   't'     'f'      'x'     compute the sum of the x-axis
                 'ydata'   'x'     'xx'     'y'     compute the sum of the y-axis

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

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

 HISTORY: 25-05-2007 Diepholz
             Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function ao_out = sum (varargin)
0002 % SUM overloads the sum operator for Analysis objects. Compute the sum value.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SUM overloads the sum operator for Analysis objects.
0007 %              Compute the sum value.
0008 %              SUM(ao) is the sum value of the elements in ao.data.
0009 %
0010 % CALL: ao_out = sum(ao_in);
0011 %       ao_out = sum(ao_in, dim);
0012 %       ao_out = sum(ao_in, pl);
0013 %       ao_out = sum(ao1, pl1, ao_vector, ao_matrix, pl2);
0014 %
0015 % POSSIBLE VALUES: ao_in  = [ao2 ao3]
0016 %                  ao_in  = ao_vector
0017 %                  ao_in  = ao_matrix
0018 %
0019 % PARAMETER LIST:  <key>           <value>             <description>
0020 %                  'dim'          1 or 2 or 3 ...    takes the sum along the
0021 %                                                    dimension dim
0022 %                          tsdata  fsdata  xydata
0023 %                 'xdata'   't'     'f'      'x'     compute the sum of the x-axis
0024 %                 'ydata'   'x'     'xx'     'y'     compute the sum of the y-axis
0025 %
0026 %                 The following call returns a parameter list object that
0027 %                 contains the default parameter values:
0028 %
0029 %                 >> pl = sum(ao, 'Params')
0030 %
0031 % HISTORY: 25-05-2007 Diepholz
0032 %             Creation
0033 %
0034 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0035 
0036 VERSION  = '$Id: sum.m,v 1.7 2007/11/26 14:48:13 ingo Exp $';
0037 ao_out   = [];
0038 
0039 % Check if this is a call for parameters
0040 if nargin == 2
0041   if isa(varargin{1}, 'ao') && ischar(varargin{2})
0042     in = char(varargin{2});
0043     if strcmp(in, 'Params')
0044       ao_out = getDefaultPL();
0045       return
0046     elseif strcmp(in, 'Version')
0047       ao_out = VERSION;
0048       return
0049     end
0050   end
0051 end
0052 
0053 %% Collect input ao's, plist's and ao variable names
0054 in_names = {};
0055 ps       = plist();
0056 for ii = 1:nargin
0057   in_names{end+1} = inputname(ii);
0058 
0059   if isnumeric(varargin{ii})
0060     ps = [ps plist(param('dim', varargin{ii}))];
0061   end
0062 end
0063 
0064 [ao_set, pl, invars] = collect_inputs(varargin, in_names);
0065 
0066 pl = combine(pl, ps);
0067 
0068 %% go through analysis objects
0069 for j=1:numel(ao_set)
0070   a = ao_set(j);
0071 
0072   [h, sum_data] = single_operation(a.data, 'sum', pl);
0073 
0074   %% Add the history from the ao object to the history
0075   h = set(h, 'inhists', [a.hist]);
0076 
0077   %% Set the var_name to the history
0078   h = set(h, 'invars', cellstr(invars{j}));
0079 
0080   do_xdata = find(pl, 'xdata');
0081   do_ydata = find(pl, 'ydata');
0082 
0083   %% Is no axis entry in the parameter list
0084   %% then set the default axis = xdata
0085   if isempty(do_xdata) && isempty(do_ydata)
0086     do_ydata = 'yes';
0087   end
0088 
0089   %% Get the operation result. It is stored in the individual axis
0090   pl_get_axis = plist([param('xdata', do_xdata) param('ydata', do_ydata)]);
0091   [sum_x, sum_y] = get_xy_values(sum_data, pl_get_axis);
0092 
0093   sum_cdata = cdata([sum_x sum_y]);
0094   sum_cdata = set (sum_cdata, 'name', sum_data.name);
0095   sum_cdata = set (sum_cdata, 'xunits', sum_data.xunits);
0096   sum_cdata = set (sum_cdata, 'yunits', sum_data.yunits);
0097 
0098   %% create a new analysis objects
0099   new_ao = a;
0100   new_ao = ao  (sum_cdata, h);
0101   new_ao = setnh(new_ao, 'name', sprintf('sum(%s)',invars{j}) );
0102 
0103   ao_out = [ao_out new_ao];
0104 
0105 end
0106 
0107 % Reshape the ouput to the same size of the input
0108 ao_out = reshape(ao_out, size(ao_set));
0109 
0110 %% Get default params
0111 function plo = getDefaultPL()
0112 
0113 plo = plist();
0114 plo = append(plo, param('xdata', ''));
0115 plo = append(plo, param('ydata', ''));
0116 plo = append(plo, param('dim',   []));
0117 
0118 
0119 % END

Generated on Tue 22-Jan-2008 10:39:13 by m2html © 2003