Home > classes > @ao > max.m

max

PURPOSE ^

MAX computes the maximum value of the data in the AO.

SYNOPSIS ^

function varargout = max(varargin)

DESCRIPTION ^

 MAX computes the maximum value of the data in the AO.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: MAX computes the maximum value of the data in the AO.

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

 PARAMETERS:  see help for data2D/applymethod for additional parameters

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

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

 VERSION:     $Id: max.m,v 1.10 2008/08/25 15:15:48 ingo Exp $

 HISTORY:     12-03-07 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % MAX computes the maximum value of the data in the AO.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: MAX computes the maximum value of the data in the AO.
0005 %
0006 % CALL:        ao_out = max(ao_in);
0007 %              ao_out = max(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('max')
0013 %
0014 %              Get information about a specified set-plist by calling:
0015 %              >> ao.getInfo('max', 'None')
0016 %
0017 % VERSION:     $Id: max.m,v 1.10 2008/08/25 15:15:48 ingo Exp $
0018 %
0019 % HISTORY:     12-03-07 M Hewitson
0020 %                 Creation
0021 %
0022 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0023 
0024 function varargout = max(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   % Get default parameters
0041   pl = combine(pl, getDefaultPlist);
0042 
0043   % Decide on a deep copy or a modify
0044   bs = copy(as, nargout);
0045 
0046   % Apply method to all AOs
0047   for j=1:numel(bs)
0048     % get max value
0049     switch find(pl, 'axis')
0050       case 'x'
0051         [mx, idx] = max(bs(j).data.getX);
0052         my = bs(j).data.getY(idx);
0053       case 'y'
0054         [my, idx] = max(bs(j).data.getY);
0055         mx = bs(j).data.getX(idx);
0056     end
0057     bs(j).setXY(mx, my, 'internal');
0058     % remove fs and nsecs
0059     if ismethod(bs(j).data, 'setFs')
0060       bs(j).setFs(NaN, 'internal');
0061     end
0062     if ismethod(bs(j).data, 'setNsecs')
0063       bs(j).data.setNsecs(NaN, 'internal');
0064     end
0065     % append history
0066     bs(j).addHistory(getInfo('None'), pl, ao_invars(j), bs(j).hist);
0067     % Set new AO name
0068     bs(j).setName(['max(' ao_invars{j} ')'], 'internal');
0069   end
0070 
0071   % Set output
0072   if nargout > 0
0073     varargout{1} = bs;
0074   end
0075 end
0076 
0077 %--------------------------------------------------------------------------
0078 % Get Info Object
0079 %--------------------------------------------------------------------------
0080 function ii = getInfo(varargin)
0081   if nargin == 1 && strcmpi(varargin{1}, 'None')
0082     sets = {};
0083     pl   = [];
0084   else
0085     sets = {'Default'};
0086     pl   = getDefaultPlist;
0087   end
0088   % Build info object
0089   ii = minfo(mfilename, 'ao', '', 'Operator', '$Id: max.m,v 1.10 2008/08/25 15:15:48 ingo Exp $', sets, pl);
0090 end
0091 
0092 %--------------------------------------------------------------------------
0093 % Get Default Plist
0094 %--------------------------------------------------------------------------
0095 function pl_default = getDefaultPlist()
0096 
0097   pl_default = plist('axis',  'y');
0098 end
0099 
0100 % END

Generated on Mon 25-Aug-2008 22:39:29 by m2html © 2003