LTPDA Toolbox™ contents Method: matrix/sqrt   Method: matrix/tdfit

Method matrix/subsData

  SUBSDATA computes the SUBSDATA of the time-series in a ltpda_container object.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: SUBSDATA applies ao/subsData to the time-series in a ltpda_container object.
 
  CALL:        out = subsData(in, pl);
 
  Note: this is just a wrapper of ao/subsData. Each AO in the ltpda_container is passed
  to ao/subsData 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
Mean
Line
Constrained Gaussian

Default
no description
Key Default Value Options Description
subsData
INDICES [] none List of start/stop index pairs for data to be subsituted (Nx2). Can either be an array of doubles or a cdata ao
SUB_FLAG [] none Timeseries AO containing ones where data should substituted and zeros where it should be kept. NOTE: This is an alternative to specifying Indices.
MODE 'Constant'
  • 'Constant'
  • 'Mean'
  • 'Line'
  • 'Constrained Gaussian'
 Method to use for calculating replacement data.
  • Constant - Replace with constant value
  • Mean - Replace with average of interval edges
  • Line - Replace with straight line between interval edges
  • Polynomial - Replace with polynomial fit to neighboring data
  • Spline - Replace with cubic spline fit to neighboring data
  • Constrained Gaussian - Replace with random data obeying statistics specified in IACF
VALUE, VALUES 0 none Value(s) to fill specified intervals. Can be a scalar or Nx1 array of doubles or ao [where y values will be taken]

Example
plist('INDICES', [[]], 'SUB_FLAG', [[]], 'MODE', 'Constant', 'VALUE', [0])

back to top back to top

Mean
no description
Key Default Value Options Description
subsData
INDICES [] none List of start/stop index pairs for data to be subsituted (Nx2). Can either be an array of doubles or a cdata ao
SUB_FLAG [] none Timeseries AO containing ones where data should substituted and zeros where it should be kept. NOTE: This is an alternative to specifying Indices.
MODE 'Constant'
  • 'Constant'
  • 'Mean'
  • 'Line'
  • 'Constrained Gaussian'
 Method to use for calculating replacement data.
  • Constant - Replace with constant value
  • Mean - Replace with average of interval edges
  • Line - Replace with straight line between interval edges
  • Polynomial - Replace with polynomial fit to neighboring data
  • Spline - Replace with cubic spline fit to neighboring data
  • Constrained Gaussian - Replace with random data obeying statistics specified in IACF

Example
plist('INDICES', [[]], 'SUB_FLAG', [[]], 'MODE', 'Constant')

back to top back to top

Line
no description
Key Default Value Options Description
subsData
INDICES [] none List of start/stop index pairs for data to be subsituted (Nx2). Can either be an array of doubles or a cdata ao
SUB_FLAG [] none Timeseries AO containing ones where data should substituted and zeros where it should be kept. NOTE: This is an alternative to specifying Indices.
MODE 'Constant'
  • 'Constant'
  • 'Mean'
  • 'Line'
  • 'Constrained Gaussian'
 Method to use for calculating replacement data.
  • Constant - Replace with constant value
  • Mean - Replace with average of interval edges
  • Line - Replace with straight line between interval edges
  • Polynomial - Replace with polynomial fit to neighboring data
  • Spline - Replace with cubic spline fit to neighboring data
  • Constrained Gaussian - Replace with random data obeying statistics specified in IACF

Example
plist('INDICES', [[]], 'SUB_FLAG', [[]], 'MODE', 'Constant')

back to top back to top

Constrained Gaussian
no description
Key Default Value Options Description
subsData
INDICES [] none List of start/stop index pairs for data to be subsituted (Nx2). Can either be an array of doubles or a cdata ao
SUB_FLAG [] none Timeseries AO containing ones where data should substituted and zeros where it should be kept. NOTE: This is an alternative to specifying Indices.
MODE 'Constant'
  • 'Constant'
  • 'Mean'
  • 'Line'
  • 'Constrained Gaussian'
 Method to use for calculating replacement data.
  • Constant - Replace with constant value
  • Mean - Replace with average of interval edges
  • Line - Replace with straight line between interval edges
  • Polynomial - Replace with polynomial fit to neighboring data
  • Spline - Replace with cubic spline fit to neighboring data
  • Constrained Gaussian - Replace with random data obeying statistics specified in IACF
SEED [] none Set the set used to initialise the random number generator which generates the random data for the gaps.
IACF [] none Inverse Auto-Correlation Function (IACF) for filling gaps. Can be array of doubles of xydata ao.

Example
plist('INDICES', [[]], 'SUB_FLAG', [[]], 'MODE', 'Constant', 'SEED', [[]], 'IACF', [[]])

back to top back to top

Some information of the method ltpda_container/subsData are listed below:
Class name ltpda_container
Method name subsData
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/sqrt  Method: matrix/sqrt   Method: matrix/tdfit Method: matrix/tdfit

©LTP Team