Home > classes > @ao > ln.m

ln

PURPOSE ^

LN overloads the log operator for Analysis objects. Natural logarithm.

SYNOPSIS ^

function ao_out = ln (varargin)

DESCRIPTION ^

 LN overloads the log operator for Analysis objects. Natural logarithm.

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

 DESCRIPTION: LN overloads the log operator for Analysis objects.
              Natural logarithm.
              LN(ao) is the natural logarithm of the elements of ao.data.

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

 HISTORY: 23-05-2007 Diepholz
             Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function ao_out = ln (varargin)
0002 % LN overloads the log operator for Analysis objects. Natural logarithm.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: LN overloads the log operator for Analysis objects.
0007 %              Natural logarithm.
0008 %              LN(ao) is the natural logarithm of the elements of ao.data.
0009 %
0010 % CALL: ao_out = ln(ao_in);
0011 %       ao_out = ln(ao_in, pl);
0012 %       ao_out = ln(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 = ln(ao, 'Params')
0027 %
0028 % HISTORY: 23-05-2007 Diepholz
0029 %             Creation
0030 %
0031 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0032 
0033 ALGONAME = mfilename;
0034 VERSION  = '$Id: ln.m,v 1.5 2007/06/22 08:32:49 ingo Exp $';
0035 ao_out   = [];
0036 pl       = [];
0037 option   = '';
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     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     [m,n] = size(a);
0056     for i = 1:m
0057       for j = 1:n
0058         ao_set  = [ao_set a(i,j)];
0059       end
0060     end
0061   elseif isa(varargin{i}, 'plist')
0062     pl = [pl varargin{i}];
0063   end
0064 end
0065 
0066 ao_out = log(ao_set, pl);
0067 
0068 %% Get default params
0069 function pl_default = getDefaultPL()
0070 
0071 disp('* creating default plist...');
0072   pl_default = plist([param('xdata',  '')
0073                       param('ydata',  '')]);
0074 disp('* done.');
0075 
0076 % END

Generated on Mon 03-Sep-2007 12:12:34 by m2html © 2003