Method ao/firwhiten


  FIRWHITEN whitens the input time-series by building an FIR whitening filter.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: FIRWHITEN whitens the input time-series by building an FIR
               whitening filter. The algorithm ultimately uses fir2() to
               build the whitening filter.
 
  ALGORITHM:
             1) Make ASD of time-series
             2) Perform running median to get noise-floor estimate (ao/smoother)
             3) Invert noise-floor estimate
             4) Call mfir() on noise-floor estimate to produce whitening filter
             5) Filter data
 
  CALL:                   b = firwhiten(a, pl) % returns whitened time-series AOs
                 [b, filts] = firwhiten(a, pl) % returns the mfir filters used
            [b, filts, nfs] = firwhiten(a, pl) % returns the noise-floor
                                               % estimates as fsdata AOs
 
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
NFFT -1 none The number of points in the FFT used to estimate
the power spectrum. If unspecified, this is calculated as Ndata/4.
BW 20 none The bandwidth of the running median filter used to
estimate the noise-floor.
HC 0.80000000000000004 none The cutoff used to reject outliers (0-1).
WIN 'Hanning'
  • 'Rectangular'
  • 'Welch'
  • 'Bartlett'
  • 'Hanning'
  • 'Hamming'
  • 'Nuttall3'
  • 'Nuttall4'
  • 'Nuttall3a'
  • 'Nuttall3b'
  • 'Nuttall4a'
  • 'Nuttall4b'
  • 'Nuttall4c'
  • 'BH92'
  • 'SFT3F'
  • 'SFT3M'
  • 'FTNI'
  • 'SFT4F'
  • 'SFT5F'
  • 'SFT4M'
  • 'FTHP'
  • 'HFT70'
  • 'FTSRS'
  • 'SFT5M'
  • 'HFT90D'
  • 'HFT95'
  • 'HFT116D'
  • 'HFT144D'
  • 'HFT169D'
  • 'HFT196D'
  • 'HFT223D'
  • 'HFT248D'
  • 'Kaiser'
  • 'levelledHanning'
Spectral window used in spectral estimation.
ORDER -1
  • -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
FIRWIN 'Hanning'
  • 'Rectangular'
  • 'Welch'
  • 'Bartlett'
  • 'Hanning'
  • 'Hamming'
  • 'Nuttall3'
  • 'Nuttall4'
  • 'Nuttall3a'
  • 'Nuttall3b'
  • 'Nuttall4a'
  • 'Nuttall4b'
  • 'Nuttall4c'
  • 'BH92'
  • 'SFT3F'
  • 'SFT3M'
  • 'FTNI'
  • 'SFT4F'
  • 'SFT5F'
  • 'SFT4M'
  • 'FTHP'
  • 'HFT70'
  • 'FTSRS'
  • 'SFT5M'
  • 'HFT90D'
  • 'HFT95'
  • 'HFT116D'
  • 'HFT144D'
  • 'HFT169D'
  • 'HFT196D'
  • 'HFT223D'
  • 'HFT248D'
  • 'Kaiser'
  • 'levelledHanning'
The window to use in the filter design.
NTAPS 256 none The length of the FIR filter to build.
back to top back to top

Some information of the method ao/firwhiten are listed below:
Class name ao
Method name firwhiten
Category Signal Processing
Package name ltpda
VCS Version 8ab8cbbc4bccf7543491a24448f4aae0b1be1c43
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team