LTPDA Toolbox™

Method ao/linSubtract

  LINSUBTRACT subtracts a linear contribution from an input ao.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: LINSUBTRACT subtracts a linear contribution from an input ao.
               The methods assumes the input data to be synchronous. The
               user selects a filter to be applied to the data before
               fitting and a time segment where the fit is performed.
 
  CALL:        c = linSubtract(a,b1,b2,b3,...,bN, pl)
 
  INPUTS:      a  - AO from where subtract linear contributions
               b  - AOs with noise contributions
               pl - parameter list (see below)
 
  OUTPUTs:     c  - output AO with contributions subtracted (tsdata)
 
  Parameters Description 
 
  EXAMPLES:
 
  1) Given the data (d):
 
              d = a + c1*b1 + c2*(b2+b3).^2
 
     where (bs) are noisy contributions added to a signal (a). To recover (a)
     in the [1 1e3] segment applying a [5e-2 0.1] 2nd order bandpass
     filter to the data, the call to the function would be
 
             pl = plist('type', 'bandpass',...
                        'fc', [5e-2 0.1],...
                        'order', 2,...
                        'times', [1 1e3],...
                        'coupling', {{'n(1)'}, {'(n(2) + n(3)).^2'}});
 
             a = linSubtract(d, b1, b2, b3, pl)
 
 
  TODO: option for parallel and serial subtraction
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

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
linSubtract
TYPE	'bandpass'	'bandpass' 'bandreject' 'highpass' 'lowpass'	Sets the type of filter used to fit the data.
FC	[]	none	Frequency cut-off of the filter.
ORDER	2	none	Order of the filter.
TIMES	[]	none	A set of times where the fit+subtraction is applied.
COUPLING	'{}'	none	A cell-array defining the model of the noise terms to be subtracted. In the cell expression 's' stands for the input ao and 'n(i)' for the N N noise contributions.

Example
plist('TYPE', 'bandpass', 'FC', [[]], 'ORDER', [2], 'TIMES', [[]], 'COUPLING', '{}')

Some information of the method ao/linSubtract are listed below:
Class name	ao
Method name	linSubtract
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/lcpsd

Method: ao/lincom

Method ao/linSubtract

Parameter Description

Default

Example