Home > classes > @ao > sqrt.m

sqrt

PURPOSE ^

SQRT overloads the sqrt operator for Analysis objects. Square root.

SYNOPSIS ^

function ao_out = sqrt (varargin)

DESCRIPTION ^

 SQRT overloads the sqrt operator for Analysis objects. Square root.

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

 DESCRIPTION: SQRT overloads the sqrt operator for Analysis objects.
              Square root.
              SQRT(ao) is the square root of the elements of ao.data.

 CALL: ao_out = sqrt(ao_in);
       ao_out = sqrt(ao_in, pl);
       ao_out = sqrt(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>
                          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 = sqrt(ao, 'Params')

 HISTORY: 24-05-2007 Diepholz
             Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

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

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