Home > classes > @ao > sum.m

sum

PURPOSE ^

SUM computes the sum of the data in the AO.

SYNOPSIS ^

function varargout = sum(varargin)

DESCRIPTION ^

 SUM computes the sum of the data in the AO.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: SUM computes the sum of the data in the AO.

 CALL:        ao_out = sum(ao_in);
              ao_out = sum(ao_in, pl);

 PARAMETERS:  see help for data2D/applymethod for additional parameters

 M-FILE INFO: Get information about this methods by calling
              >> ao.getInfo('sum')

              Get information about a specified set-plist by calling:
              >> ao.getInfo('sum', 'None')

 VERSION:     $Id: sum.m,v 1.15 2008/09/05 11:15:19 ingo Exp $

 HISTORY:     12-03-07 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % SUM computes the sum of the data in the AO.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: SUM computes the sum of the data in the AO.
0005 %
0006 % CALL:        ao_out = sum(ao_in);
0007 %              ao_out = sum(ao_in, pl);
0008 %
0009 % PARAMETERS:  see help for data2D/applymethod for additional parameters
0010 %
0011 % M-FILE INFO: Get information about this methods by calling
0012 %              >> ao.getInfo('sum')
0013 %
0014 %              Get information about a specified set-plist by calling:
0015 %              >> ao.getInfo('sum', 'None')
0016 %
0017 % VERSION:     $Id: sum.m,v 1.15 2008/09/05 11:15:19 ingo Exp $
0018 %
0019 % HISTORY:     12-03-07 M Hewitson
0020 %                 Creation
0021 %
0022 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0023 
0024 function varargout = sum(varargin)
0025 
0026   % Check if this is a call for parameters
0027   if utils.helper.isinfocall(varargin{:})
0028     varargout{1} = getInfo(varargin{3});
0029     return
0030   end
0031 
0032   % Collect input variable names
0033   in_names = cell(size(varargin));
0034   for ii = 1:nargin,in_names{ii} = inputname(ii);end
0035 
0036   % Collect all AOs
0037   [as, ao_invars] = utils.helper.collect_objects(varargin(:), 'ao', in_names);
0038   pl              = utils.helper.collect_objects(varargin(:), 'plist', in_names);
0039 
0040   % Decide on a deep copy or a modify
0041   bs = copy(as, nargout);
0042 
0043   % Apply method to all AOs
0044   applymethod(bs, ao_invars, 'sum', pl, getDefaultPlist, getInfo);
0045 
0046   % Set output
0047   if nargout > 0
0048     varargout{1} = bs;
0049   end
0050 end
0051 
0052 %--------------------------------------------------------------------------
0053 % Get Info Object
0054 %--------------------------------------------------------------------------
0055 function ii = getInfo(varargin)
0056   if nargin == 1 && strcmpi(varargin{1}, 'None')
0057     sets = {};
0058     pl   = [];
0059   else
0060     sets = {'Default'};
0061     pl   = getDefaultPlist;
0062   end
0063   % Build info object
0064   ii = minfo(mfilename, 'ao', '', utils.const.categories.op, '$Id: sum.m,v 1.15 2008/09/05 11:15:19 ingo Exp $', sets, pl);
0065 end
0066 
0067 %--------------------------------------------------------------------------
0068 % Get Default Plist
0069 %--------------------------------------------------------------------------
0070 function pl_default = getDefaultPlist()
0071 
0072   pl_default = plist('axis',  'y');
0073 end
0074 
0075 % END

Generated on Mon 08-Sep-2008 13:18:47 by m2html © 2003