Method ao/average


  AVERAGE averages aos point-by-point
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: AVERAGE averages aos point-by-point.
               For each point, an average is taken over all the input objects.
               The uncertainty is calculated as the standard deviation of the mean.
               The objects must have the same length and yunits.
 
          s1:   2 1 2 5 2 3 3
          s2:   7 2 3 4 2 1 1
          s3:   0 0 7 6 5 5 5
          ===================
          out:  3 1 4 5 3 3 3
 
  CALL:        b = average(a1, a2, a3, ..., pl)
 
  EXAMPLES:
 
  a1 = ao(plist('waveform', 'noise', 'nsecs', 1000, 'fs', 1, 'yunits', 'm'));
  a2 = ao(plist('waveform', 'noise', 'nsecs', 1000, 'fs', 1, 'yunits', 'm'));
  a3 = ao(plist('waveform', 'noise', 'nsecs', 1000, 'fs', 1, 'yunits', 'm'));
  a4 = average(a1, a2, a3);
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
average
WEIGHTS 'NONE'
  • 'NONE'
  • 'DY2'
  • 'DY^2'
  • 'DY'
Option to calculate a weighted mean. Choose a method between:
  • none - no weigthing done
  • dy2, dy^2 - weights will be taken from objects dy field as w = 1/dy^2
  • dy - weights will be taken from objects dy field as w = 1/dy

Example

plist('WEIGHTS', 'NONE')

back to top back to top

Some information of the method ao/average are listed below:
Class name ao
Method name average
Category Signal Processing
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 0
Supported numeric types {'double'}




©LTP Team