LTPDA Toolbox™ | contents | ![]() ![]() |
TWOTERMCORRELATION computes the two-term correlation coefficients. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% DESCRIPTION: TWOTERMCORRELATION computes the correlation terms of two signals with a third. The resulting terms can be used to subtract the contributions. CALL: terms = twoTermCorrelation(X, A, B, pl); INPUTS: X - the target time-series A - the first contributing time-series B - the second contributing time-series The method computes: den = PSD_A .* PSD_B - real(CSD_B_A).^2; alpha_num = real(CSD_X_A).*PSD_B - real(CSD_X_B).*real(CSD_B_A); beta_num = real(CSD_X_B).*PSD_A - real(CSD_X_A).*real(CSD_B_A); and returns: alpha = alpha_num ./ den beta = beta_num ./ den The CPSD and PSD terms are averaged over the frequencies given in the plist (all frequencies if empty) and a single value for each coefficient is calculated. OUTPUTS: terms - a matrix object containing two AOs, each of which is the correlation (alpha and beta) of the input signals with the target. Parameters Description %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details | |
---|---|
Access | public |
Defining Class | ao |
Sealed | 0 |
Static | 0 |
Sets for this method … |
---|
Default |
Default |
|||
---|---|---|---|
no description | |||
Key | Default Value | Options | Description |
FREQUENCIES, F | [] | none | The range of frequencies to include in the output. If empty, all frequecies will be returned. |
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 | 'BH92' |
|
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 |
|
The order of segment detrending:
|
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:
|
Some information of the method ao/twoTermCorrelation are listed below: | |
---|---|
Class name | ao |
Method name | twoTermCorrelation |
Category | Signal Processing |
Package name | LPF_DA_Module |
VCS Version | 9261be27dd1a3f454871757ac6dc9e0fb5b06f94 |
Min input args | 1 |
Max input args | -1 |
Min output args | 1 |
Max output args | -1 |
![]() |
Method: ao/toSI | Method: ao/upsample | ![]() |
©LTP Team