LTPDA Toolbox™ contents Method: ao/asin   Method: ao/atan2

Method ao/atan

  ATAN overloads the atan method for analysis objects.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: ATAN overloads the atan operator for analysis objects.
               Inverse tangent result in radians.
               ATAN(ao) is the arctangent of the elements of ao.data.
 
  CALL:        ao_out = atan(ao_in);
               ao_out = atan(ao_in, pl);
               ao_out = atan(ao1, pl1, ao_vector, ao_matrix, pl2);
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Sets for this method …
1D
2D
3D

1D
no description
Key Default Value Options Description
atan
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.

Example
plist('AXIS', 'y', 'DIM', [[]], 'OPTION', '')

back to top back to top

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

Example
plist('AXIS', 'y', 'OPTION', '')

back to top back to top

3D
no description
Key Default Value Options Description
atan
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.

Example
plist('AXIS', 'z', 'DIM', [[]], 'OPTION', '')

back to top back to top

Some information of the method ao/atan are listed below:
Class name ao
Method name atan
Category Trigonometry
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 1
Max input args -1
Min output args 1
Max output args -1
Can be used as modifier 1
Supported numeric types {'double'}



Method: ao/asin  Method: ao/asin   Method: ao/atan2 Method: ao/atan2

©LTP Team