Method ao/cohere


  COHERE estimates the coherence between time-series objects
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: COHERE estimates the coherence between the
               time-series objects in the input analysis objects. 
               The estimate is done by taking 
               the ratio of the CPSD between the two inputs, Sxy, divided by 
               the product of the PSDs of the inputs, Sxx and Syy,              
               and is either magnitude-squared: (abs(Sxy))^2 / (Sxx * Syy) 
               or complex value: Sxy / sqrt(Sxx * Syy)
               Here x is the first input, y is the second input
 
  CALL:        b = cohere(a1,a2,pl)
 
  INPUTS:      a1   - input analysis object
               a2   - input analysis object
               pl   - input parameter list
 
  OUTPUTS:     b    - output analysis object
 
  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 samples in each fft [default: length of input data].
A string value containing the variable 'fs' can also be used, e.g.,
plist('Nfft', '2*fs')
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'
The window to be applied to the data to remove the discontinuities at edges of segments. [default: taken from user prefs]
Only the design parameters of the window object are used. Enter a string value containing the window name e.g.
plist('Win', 'Kaiser', 'psll', 200)
plist('Win', 'BH92')
PSLL 200 none The peak sidelobe level for Kaiser windows.
Note: it is ignored for all other windows
OLAP -1 none The segment percent overlap [-1 == take from window function]
ORDER, N 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
NAVS -1 none Force number of averages. If set, and if Nfft was set to 0 or -1,
the number of points for each window will be calculated to match the request.
TIMES, SPLIT [] none The time range to analyze. If not empty, sets the time interval to operate on.
As in ao/split, the interval can be specified by:
  • a vector of doubles
  • a timespan object
  • a cell array of time strings
  • a vector of time objects
TYPE 'C'
  • 'C'
  • 'MS'
type of output scaling. Choose from:
  • MS - Magnitude-Squared Coherence:
    (abs(Sxy))^2 / (Sxx * Syy)
  • C - Complex Coherence:
    Sxy / sqrt(Sxx * Syy)
back to top back to top

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




©LTP Team