Method ao/abs


  ABS overloads the Absolute value method for analysis objects.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: ABS overloads the Absolute value operator for analysis objects.
 
  CALL:        ao_out = abs(ao_in);
               ao_out = abs(ao_in, pl);
 
  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/abs are listed below:
Class name ao
Method name abs
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