Home > classes > @ao > real.m

real

PURPOSE ^

REAL overloads the real operator for Analysis objects.

SYNOPSIS ^

function ao_out = real(varargin)

DESCRIPTION ^

 REAL overloads the real operator for Analysis objects.

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

 DESCRIPTION: REAL overloads the real operator for Analysis objects.

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

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

 PARAMETER LIST:  <key>           <value>             <description>
                          tsdata  fsdata  xydata
                 'xdata'   't'     'f'      'x'     compute the xdata
                 'ydata'   'x'     'xx'     'y'     compute the ydata

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

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

 VERSION: $Id: real.m,v 1.2 2007/10/09 14:05:25 ingo Exp $

 HISTORY: 20-0802007 Diepholz
             Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function ao_out = real(varargin)
0002 % REAL overloads the real operator for Analysis objects.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: REAL overloads the real operator for Analysis objects.
0007 %
0008 % CALL: ao_out = real(ao_in);
0009 %       ao_out = real(ao_in, pl);
0010 %
0011 % POSSIBLE VALUES: ao_in  = [ao2 ao3]
0012 %                  ao_in  = ao_vector
0013 %                  ao_in  = ao_matrix
0014 %
0015 % PARAMETER LIST:  <key>           <value>             <description>
0016 %                          tsdata  fsdata  xydata
0017 %                 'xdata'   't'     'f'      'x'     compute the xdata
0018 %                 'ydata'   'x'     'xx'     'y'     compute the ydata
0019 %
0020 % The following call returns a parameter list object that contains the
0021 % default parameter values:
0022 %
0023 % >> pl = real(ao, 'Params')
0024 %
0025 % VERSION: $Id: real.m,v 1.2 2007/10/09 14:05:25 ingo Exp $
0026 %
0027 % HISTORY: 20-0802007 Diepholz
0028 %             Creation
0029 %
0030 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0031 
0032 VERSION  = '$Id: real.m,v 1.2 2007/10/09 14:05:25 ingo Exp $';
0033 ao_out   = [];
0034 pl       = [];
0035 
0036 %% Check if this is a call for parameters
0037 if nargin == 2
0038   if isa(varargin{1}, 'ao') && ischar(varargin{2})
0039     in = char(varargin{2});
0040     if strcmp(in, 'Params')
0041       ao_out = getDefaultPL();
0042       return
0043     elseif strcmp(in, 'Version')
0044       ao_out = VERSION;
0045       return
0046     end
0047   end
0048 end
0049 
0050 %% store the input ao's in the vector: ao_set
0051 ao_set = [];
0052 for i=1:nargin
0053   a = varargin{i};
0054   if isa(a, 'ao')
0055     ao_set  = [ao_set a];
0056   elseif isa(varargin{i}, 'plist')
0057     pl = [pl varargin{i}];
0058   end
0059 end
0060 
0061 if ~isempty (pl)
0062   pl = combine(pl);
0063 end
0064 
0065 %% go through analysis objects
0066 for j=1:numel(ao_set)
0067   a = ao_set(j);
0068 
0069   [h, real_data] = single_operation(a.data, 'real', pl);
0070 
0071   %% Add the history from the ao object to the history
0072   h = set(h, 'inhists', [a.hist]);
0073 
0074   %% Set the var_name to the history
0075   if (j <= nargin)
0076     if (isempty (inputname(j)))
0077       h = set(h, 'invars', cellstr('no var_name'));
0078     else
0079       h = set(h, 'invars', cellstr(inputname(j)));
0080     end
0081   else
0082     h = set(h, 'invars', cellstr('no var_name'));
0083   end
0084 
0085   %% create a new analysis objects
0086   new_ao = a;
0087   new_ao = ao  (real_data, h);
0088   new_ao = set (new_ao, 'name', sprintf('real(%s)',a.name) );
0089 
0090   ao_out = [ao_out new_ao];
0091 
0092 end
0093 
0094 % Reshape the ouput to the same size of the input
0095 ao_out = reshape(ao_out, size(ao_set));
0096 
0097 
0098 %% Get default params
0099 function pl_default = getDefaultPL()
0100 
0101   pl_default = plist([param('xdata',  '')
0102                       param('ydata',  '')]);
0103 
0104 
0105 % END

Generated on Thu 01-Nov-2007 09:42:34 by m2html © 2003