LTPDA Toolbox™

Method ao/timeaverage

  TIMEAVERAGE Averages time series intervals
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: Averages time series intervals and return a reduced time
  series where each point represents the average of a stretch of data.
  Despite the name this method can perform some different operations on the
  data stretches or apply a user supplied function. Different functions can
  be applied to X and Y data.
 
  CALL:        BS = timeaverage(A1, A2, A3, ..., PL)
 
  INPUTS:      AN   - time series AOs
               PL   - parameters list
 
  OUTPUTS:     BS   - array of AOs
  
  Parameters Description
 
  EXAMPLES:
  
  >> times_list = [ 0 100 200 300 400 500 ]
  >> m = timeaverage(a, plist('times', times_list))
  >> timeaverage(a, plist('start time', 0, 'duration', 100, 'decay', 10, 'repetitions', 3))
  >> timeaverage(a, plist('times', times_list, 'function', 'center'))
  >> m = timeaverage(a, plist('times', times_list, 'function', @mean))
  >> m = timeaverage(a, plist('times', times_list, 'xfunction', @min, 'yfunction', @mean))
 
  NOTES: The intervals are defined as ti <= x < te where ti is the start
  time and te is the end time of each interval. If not specified the TIMES
  vector is constructed from other parameters using the following schema
  repeated accordingly a number of times specified with the REPETITIONS
  parameter.
 
        settling      duration      decay     settling      duration
     |------------|##############|---------|------------|##############|---
   START
 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Method Details
Access	public
Defining Class	ao
Sealed	0
Static	0

Parameter Description

Sets for this method …
Default

Default
no description
Key	Default Value	Options	Description
timeaverage
METHOD	'MEAN'	'MEAN' 'MEDIAN' 'MAX' 'MIN' 'RMS' 'CENTER'	Reduction method to apply to data stretches.
FUNCTION	[]	none	Function to apply to data stretches. It can be a function name or a function handle to a function that accepts a vector and returns a scalar.
XFUNCTION	[]	none	Function to apply to X data stretches. It can be a function name or a function handle to a function that accepts a vector and returns a scalar.
YFUNCTION	[]	none	Function to apply to Y data stretches. It can be a function name or a function handle to a function that accepts a vector and returns a scalar.
TIMES	[]	none	An array of start-stop times to split by. Array of timespan objects are also supported.
START TIME	0	none	Start time of the measurement.
DURATION	0	none	Duration of each cicle.
REPETITIONS	1	none	Number of cycles.
SETTLING TIME	0	none	Settling time in each cicle.
DECAY TIME	0	none	Decay time in each cicle.

Example
plist('METHOD', 'MEAN', 'FUNCTION', [[]], 'XFUNCTION', [[]], 'YFUNCTION', [[]], 'TIMES', [[]], 'START TIME', [0], 'DURATION', [0], 'REPETITIONS', [1], 'SETTLING TIME', [0], 'DECAY TIME', [0])

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

Method: ao/tfe

Method: ao/toSI

Method ao/timeaverage

Parameter Description

Default

Example