Method ao/mean


  MEAN computes the mean value of the data in the AO.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: MEAN computes the mean value of the data in the AO.
  The uncertainty is evaluated as the standard deviation of the mean.
 
  CALL:        b = mean(a)
               b = mean(a, pl)
 
  INPUTS:      pl   - a parameter list
               a    - input analysis object
 
  OUTPUTS:     b  - output analysis object
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

1D

no description
Key Default Value Options Description
mean
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
mean
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
mean
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/mean are listed below:
Class name ao
Method name mean
Category Operator
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'}




©LTP Team