LTPDA Toolbox™ contents Method: matrix/delay   Method: matrix/diff

Method matrix/detrend

  DETREND detrends the analysis objects in a ltpda_container object using a polynomial of degree N.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: DETREND detrends the analysis objects in a ltpda_container 
               object using a polynomial of degree N.
 
  CALL:        out = detrend(in, pl);
 
  Note: this is just a wrapper of ao/detrend. Each AO in the ltpda_container is passed
  to ao/detrend 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
detrend
ORDER, N 1
  • -1
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
 The order of detrending:
  • -1 - no detrending
  • 0 - subtract mean
  • 1 - subtract linear fit
  • N - subtract fit of polynomial, order N
M-FILE ONLY 1
  • 1
  • 0
 Using M-file call
TIMES [] none Evaluate the trend only on a limited data segment, and then detrend the whole data set.
An array of start/stop times to split by.
The times should be relativeto the object reference time (t0).

Example
plist('ORDER', [1], 'M-FILE ONLY', [true], 'TIMES', [[]])

back to top back to top

Some information of the method ltpda_container/detrend are listed below:
Class name ltpda_container
Method name detrend
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/delay  Method: matrix/delay   Method: matrix/diff Method: matrix/diff

©LTP Team