Method ao/consolidate


  CONSOLIDATE resamples all input AOs onto the same time grid.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  CONSOLIDATE resamples all input AOs onto the same time grid and truncates all
              time-series to start at the maximum start time of the inputs and end
              at the minimum stop time of the inputs.
 
  ALGORITHM:
              1) Drop duplicate samples (ao.dropduplicates)
              2) Interpolate missing samples (ao.interpmissing)
              3) Fix uneven sample rate using interpolate (ao.fixfs)
              4) Resample to same fs, either max or specified (ao.resample
                 or ao.interp depending on ratio of old and new sample
                 rate)
              5) Truncate all vectors to minimum overlap of time-series
                 (ao.split)
              6) Resample on to the same timing grid (ao.interp)
              7) Truncate all vectors to same number of samples to correct for
                 any rounding errors in previous steps (ao.select)
 
  CALL:       >> bs = consolidate(as)
 
  INPUTS:     as  - array of time-series analysis objects
              pl  - parameter list (see below)
 
  OUTPUTS:    bs  - array of analysis objects, one for each input
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
consolidate
FS [] none The target sampling frequency for consolidate
INTERP_METHOD 'linear'
  • 'nearest'
  • 'linear'
  • 'spline'
  • 'cubic'
The method for the interpolation step
FIXFS_METHOD 'Time'
  • 'Time'
  • 'Samples'
The method for the fixfs step
TRUNCATE 1
  • 1
  • 0
Truncate final data set to the shortes overlapping interval.
dropduplicates
TOL 0.0050000000000000001 none The time interval tolerance to consider two consecutive samples as duplicates.
interpmissing
D 1.5 none The time interval tolerance for finding missing samples.
interp
METHOD 'auto'
  • 'auto'
  • 'nearest'
  • 'linear'
  • 'spline'
  • 'pchip'
  • 'v5cubic'
Specify the interpolation method. Choose between:
  • auto - use a method according to the data type. Spline for double/single, nearest for all other types.
    • nearest - nearest neighbor interpolation
    • linear - linear interpolation
    • spline - piecewise cubic spline interpolation (SPLINE)
    • pchip - shape-preserving piecewise cubic interpolation
    • v5cubic - the cubic interpolation from MATLAB 5, which does not extrapolate and uses 'spline' if X is not equally spaced.
fixfs
FILTER 'off'
  • 'iir'
  • 'fir'
  • 'off'
Specify options for the antialiasing filter.
INTERPOLATION 'auto'
  • 'auto'
  • 'nearest'
  • 'linear'
  • 'spline'
  • 'pchip'
  • 'v5cubic'
Specify the interpolation method. Choose between:
  • auto - use a method according to the data type. Spline for double/single, nearest for all other types.
    • nearest - nearest neighbor interpolation
    • linear - linear interpolation
    • spline - piecewise cubic spline interpolation (SPLINE)
    • pchip - shape-preserving piecewise cubic interpolation
    • v5cubic - the cubic interpolation from MATLAB 5, which does not extrapolate and uses 'spline' if X is not equally spaced.

Example

plist('FS', [[]], 'INTERP_METHOD', 'linear', 'FIXFS_METHOD', 'Time', 'TRUNCATE', [true], 'TOL', [0.0050000000000000001], 'D', [1.5], 'METHOD', 'auto', 'FILTER', 'off', 'INTERPOLATION', 'auto')

back to top back to top

Some information of the method ao/consolidate are listed below:
Class name ao
Method name consolidate
Category Signal Processing
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 2
Max input args -1
Min output args 1
Max output args -1
Can be used as modifier 0
Supported numeric types {'double'}




©LTP Team