LTPDA Toolbox™ contents Method: matrix/tfe   Method: matrix/uminus

Method matrix/timeaverage

  TIMEAVERAGE Averages time series intervals in a ltpda_container object.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: TIMEAVERAGE Averages time series intervals in a ltpda_container object.
 
  CALL:        out = timeaverage(in, pl);
 
  Note: this is just a wrapper of ao/timeaverage. Each AO in the ltpda_container is passed
  to ao/timeaverage with the input plist. 
  
  INPUTS:      in      -  input ltpda_container objects 
               pl      -  parameter list
 
  OUTPUTS:     out     -  output ltpda_container objects 
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ltpda_container
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])

back to top back to top

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



Method: matrix/tfe  Method: matrix/tfe   Method: matrix/uminus Method: matrix/uminus

©LTP Team