LTPDA Toolbox™ contents Method: ao/find   Method: ao/fromProcinfo

Method ao/flscov

  FLSCOV.M - Tool to perform a least square fit in frequency domain.
 
  DESCRIPTION:  
 
  CALL: 
        >> pest_obj = flscov([ao_0, ao_1, ao_2 ..., ao_N],pl)
 
        where the first object of the ao input array is considered to be
        the output data in the relation 
 
                ao_0 = c_1 * ao_1 + c_2 * ao_2 + ... + c_N * ao_N
    
        The c_i are the parameters to be estimated.
 
  PARAMETERS: - pest_obj:   pest object
              - ao:         ao object
              - pl:         plist
 
     EXAMPLE: - flscov(p,plist())
 
 ParametersDescription
 
  DV & NK 2015
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
flscov
FITPARAMS {} [0x0] none A cell array containing the names of the parameters to be estimated.
FREQUENCIES [] none The frequency range. Must be a [2x1] array with the minimum and maximum frequencies of the analysis.
NAME 'Frequency domain chi^2 fit' none The name of the result of the fit.
TRIM [100 -100] none A 2x1 vector that denotes the samples to split from the star and end of the time-series (split in offsets).
WIN 'BH92' none The window to apply to the data.
NAVS 10 none The Number of averages for the PSD of the noise.
OLAP -1 none The segment percent overlap [-1 == take from window function]
NOISE MODEL [] none The given noise model. It may be a) an AO time-series with the appropriate Y units, b) an AO frequency-series of the correct size (NoutputsXNoutputs), c) a SMODEL (function of freqs) of the correct size (NoutputsXNoutputs) d) a MFH object.
INTERPOLATION METHOD 'linear'
  • 'nearest'
  • 'linear'
  • 'spline'
  • 'pchip'
  • 'cubic'
  • 'v5cubic'
 The interpolation method for the computation of the inverse cross-spectrum matrix.
ORDER 0
  • -1
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
 The order of segment detrending:
  • -1 - no detrending
  • 0 - subtract mean
  • 1 - subtract linear fit
  • N - subtract fit of polynomial, order N
YUNITS [] none The Y units of the parameters to be estimated. The 'UNIT' objects must be used.
DOPLOT 1
  • 1
  • 0
 True-False flag to plot the residual time series.
BIN DATA 1
  • 1
  • 0
 Set to true to re-bin the measured noise data.
FIT NOISE MODEL 0
  • 0
  • 1
 Set to true to attempt a fit on the noise spectra using the 'polyfitSpectrum' function.
POLYNOMIAL ORDER [-10 -9 -8 -7 -6 -5 -4 -3 -2 -1 0 1 2 3 4 5 6 7 8 9 10] none The order of the polynomial to be used in the 'polyfitSpectrum' function.
K0 1 none The first FFT coefficient of the analysis. All K
K1 1 none The k1 coefficient to downsample in frequency domain. More info found in Phys. Rev. D 90, 042003. If left empty, all the spectra is used.
P TOL 0.01 none The tolerance for terminating the outer loop. The iterations will stop if the change in the p0-p0_previous is less than this value.
MAXITER 1 none The maximum number of iterations of the outer chi^2 loop.

Example
plist('FITPARAMS', cell(0,0), 'FREQUENCIES', [[]], 'NAME', 'Frequency domain chi^2 fit', 'TRIM', [[100 -100]], 'WIN', 'BH92', 'NAVS', [10], 'OLAP', [-1], 'NOISE MODEL', [[]], 'INTERPOLATION METHOD', 'linear', 'ORDER', [0], 'YUNITS', [ unit(' ') ], 'DOPLOT', [true], 'BIN DATA', [true], 'FIT NOISE MODEL', [false], 'POLYNOMIAL ORDER', [[-10 -9 -8 -7 -6 -5 -4 -3 -2 -1 0 1 2 3 4 5 6 7 8 9 10]], 'K0', [1], 'K1', [1], 'P TOL', [0.01], 'MAXITER', [1])

back to top back to top

Some information of the method ao/flscov are listed below:
Class name ao
Method name flscov
Category Helper
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/find  Method: ao/find   Method: ao/fromProcinfo Method: ao/fromProcinfo

©LTP Team