Method ao/log


  LOG overloads the log operator for analysis objects. Natural logarithm.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: LOG overloads the log operator for analysis objects.
               Natural logarithm.
               LOG(ao) is the natural logarithm of the elements of ao.data.
 
  CALL:        ao_out = log(ao_in);
               ao_out = log(ao_in, pl);
               ao_out = log(ao1, pl1, ao_vector, ao_matrix, pl2);
 
  PARAMETERS:  see help for data2D/applymethod for additional parameters
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

1D

no description
Key Default Value Options Description
AXIS 'y' none The axis on which to apply the method.
DIM [] none The dimension of the chosen vector to apply the method to. This is necessary for functions like mean() when applied to matrices held in cdata objects. For tsdata, fsdata or xydata, this option has no effect.
OPTION '' none Any additional option to pass to the method.
back to top back to top

2D

no description
Key Default Value Options Description
AXIS 'y'
  • 'x'
  • 'y'
  • 'xy'
The axis on which to apply the method.
OPTION '' none Any additional option to pass to the method.
back to top back to top

3D

no description
Key Default Value Options Description
AXIS 'z'
  • 'x'
  • 'y'
  • 'z'
  • 'xyz'
The axis on which to apply the method.
DIM [] none The dimension of the chosen vector to apply the method to. This is necessary for functions like mean() when applied to matrices held in the z field of xyzdata objects.
OPTION '' none Any additional option to pass to the method.
back to top back to top

Some information of the method ao/log are listed below:
Class name ao
Method name log
Category Operator
Package name ltpda
VCS Version 3542afe99dea25c636b7ac3b82a9f6f8be9d447d
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team