NAG Library Routine Document
g13cef (multi_spectrum_bivar)
1
Purpose
For a bivariate time series, g13cef calculates the cross amplitude spectrum and squared coherency, together with lower and upper bounds from the univariate and bivariate (cross) spectra.
2
Specification
Fortran Interface
Subroutine g13cef ( 
xg, yg, xyrg, xyig, ng, stats, ca, calw, caup, t, sc, sclw, scup, ifail) 
Integer, Intent (In)  ::  ng  Integer, Intent (Inout)  ::  ifail  Real (Kind=nag_wp), Intent (In)  ::  xg(ng), yg(ng), xyrg(ng), xyig(ng), stats(4)  Real (Kind=nag_wp), Intent (Out)  ::  ca(ng), calw(ng), caup(ng), t, sc(ng), sclw(ng), scup(ng) 

C Header Interface
#include nagmk26.h
void 
g13cef_ (const double xg[], const double yg[], const double xyrg[], const double xyig[], const Integer *ng, const double stats[], double ca[], double calw[], double caup[], double *t, double sc[], double sclw[], double scup[], Integer *ifail) 

3
Description
Estimates of the cross amplitude spectrum
$A\left(\omega \right)$ and squared coherency
$W\left(\omega \right)$ are calculated for each frequency
$\omega $ as
where
 $cf\left(\omega \right)$ and $qf\left(\omega \right)$ are the cospectrum and quadrature spectrum estimates between the series, i.e., the real and imaginary parts of the cross spectrum ${f}_{xy}\left(\omega \right)$ as obtained using g13ccf or g13cdf;
 ${f}_{xx}\left(\omega \right)$ and ${f}_{yy}\left(\omega \right)$ are the univariate spectrum estimates for the two series as obtained using g13caf or g13cbf.
The same type and amount of smoothing should be used for these estimates, and this is specified by the degrees of freedom and bandwidth values which are passed from the calls of
g13caf or
g13cbf.
Upper and lower
$95\%$ confidence limits for the cross amplitude are given approximately by
except that a negative lower limit is reset to
$0.0$, in which case the approximation is rather poor. You are therefore particularly recommended to compare the coherency estimate
$W\left(\omega \right)$ with the critical value
$T$ derived from the upper
$5\%$ point of the
$F$distribution on
$\left(2,d2\right)$ degrees of freedom:
where
$d$ is the degrees of freedom associated with the univariate spectrum estimates. The value of
$T$ is returned by the routine.
The hypothesis that the series are unrelated at frequency $\omega $, i.e., that both the true cross amplitude and coherency are zero, may be rejected at the $5\%$ level if $W\left(\omega \right)>T$. Tests at two frequencies separated by more than the bandwidth may be taken to be independent.
The confidence limits on $A\left(\omega \right)$ are strictly appropriate only at frequencies for which the coherency is significant. The same applies to the confidence limits on $W\left(\omega \right)$ which are however calculated at all frequencies using the approximation that $\mathrm{arctanh}\left(\sqrt{W\left(l\right)}\right)$ is Normal with variance $1/d$.
4
References
Bloomfield P (1976) Fourier Analysis of Time Series: An Introduction Wiley
Jenkins G M and Watts D G (1968) Spectral Analysis and its Applications Holden–Day
5
Arguments
 1: $\mathbf{xg}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the
ng univariate spectral estimates,
${f}_{xx}\left(\omega \right)$, for the
$x$ series.
 2: $\mathbf{yg}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the
ng univariate spectral estimates,
${f}_{yy}\left(\omega \right)$, for the
$y$ series.
 3: $\mathbf{xyrg}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the real parts,
$cf\left(\omega \right)$, of the
ng bivariate spectral estimates for the
$x$ and
$y$ series. The
$x$ series leads the
$y$ series.
 4: $\mathbf{xyig}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the imaginary parts,
$qf\left(\omega \right)$, of the
ng bivariate spectral estimates for the
$x$ and
$y$ series. The
$x$ series leads the
$y$ series.
Note: the two univariate and the bivariate spectra must each have been calculated using the same method of smoothing. For rectangular, Bartlett, Tukey or Parzen smoothing windows, the same cutoff point of lag window and the same frequency division of the spectral estimates must be used. For the trapezium frequency smoothing window, the frequency width and the shape of the window and the frequency division of the spectral estimates must be the same. The spectral estimates and statistics must also be unlogged.
 5: $\mathbf{ng}$ – IntegerInput

On entry: the number of spectral estimates in each of the arrays
xg,
yg,
xyrg and
xyig. It is also the number of cross amplitude spectral and squared coherency estimates.
Constraint:
${\mathbf{ng}}\ge 1$.
 6: $\mathbf{stats}\left(4\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the four associated statistics for the univariate spectral estimates for the $x$ and $y$ series. ${\mathbf{stats}}\left(1\right)$ contains the degrees of freedom, ${\mathbf{stats}}\left(2\right)$ and ${\mathbf{stats}}\left(3\right)$ contain the lower and upper bound multiplying factors respectively and ${\mathbf{stats}}\left(4\right)$ contains the bandwidth.
Constraints:
 ${\mathbf{stats}}\left(1\right)\ge 3.0$;
 $0.0<{\mathbf{stats}}\left(2\right)\le 1.0$;
 ${\mathbf{stats}}\left(3\right)\ge 1.0$.
 7: $\mathbf{ca}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the
ng cross amplitude spectral estimates
$\hat{A}\left(\omega \right)$ at each frequency of
$\omega $.
 8: $\mathbf{calw}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the
ng lower bounds for the
ng cross amplitude spectral estimates.
 9: $\mathbf{caup}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the
ng upper bounds for the
ng cross amplitude spectral estimates.
 10: $\mathbf{t}$ – Real (Kind=nag_wp)Output

On exit: the critical value for the significance of the squared coherency, $T$.
 11: $\mathbf{sc}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the
ng squared coherency estimates,
$\hat{W}\left(\omega \right)$ at each frequency
$\omega $.
 12: $\mathbf{sclw}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the
ng lower bounds for the
ng squared coherency estimates.
 13: $\mathbf{scup}\left({\mathbf{ng}}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the
ng upper bounds for the
ng squared coherency estimates.
 14: $\mathbf{ifail}$ – IntegerInput/Output

On entry:
ifail must be set to
$0$,
$1\text{ or}1$. If you are unfamiliar with this argument you should refer to
Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value
$1\text{ or}1$ is recommended. If the output of error messages is undesirable, then the value
$1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is
$0$.
When the value $\mathbf{1}\text{ or}\mathbf{1}$ is used it is essential to test the value of ifail on exit.
On exit:
${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
${\mathbf{ifail}}=0$ or
$1$, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
 ${\mathbf{ifail}}=1$

On entry,  ${\mathbf{ng}}<1$, 
or  ${\mathbf{stats}}\left(1\right)<3.0$, 
or  ${\mathbf{stats}}\left(2\right)\le 0.0$, 
or  ${\mathbf{stats}}\left(2\right)>1.0$, 
or  ${\mathbf{stats}}\left(3\right)<1.0$. 
 ${\mathbf{ifail}}=2$

A bivariate spectral estimate is zero. For this frequency the cross amplitude spectrum and squared coherency and their bounds are set to zero.
 ${\mathbf{ifail}}=3$

A univariate spectral estimate is negative. For this frequency the cross amplitude spectrum and squared coherency and their bounds are set to zero.
 ${\mathbf{ifail}}=4$

A univariate spectral estimate is zero. For this frequency the cross amplitude spectrum and squared coherency and their bounds are set to zero.
 ${\mathbf{ifail}}=5$

A calculated value of the squared coherency exceeds $1.0$. For this frequency the squared coherency is reset to $1.0$ and this value for the squared coherency is used in the formulae for the calculation of bounds for both the cross amplitude spectrum and squared coherency. This has the consequence that both squared coherency bounds are $1.0$.
 ${\mathbf{ifail}}=99$
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 3.9 in How to Use the NAG Library and its Documentation for further information.
 ${\mathbf{ifail}}=399$
Your licence key may have expired or may not have been installed correctly.
See
Section 3.8 in How to Use the NAG Library and its Documentation for further information.
 ${\mathbf{ifail}}=999$
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
If more than one failure of the types
$2$,
$3$,
$4$ and
$5$ occurs then the failure type which occurred at lowest frequency is returned in
ifail. However the actions indicated above are also carried out for failures at higher frequencies.
7
Accuracy
All computations are very stable and yield good accuracy.
8
Parallelism and Performance
g13cef is not threaded in any implementation.
The time taken by
g13cef is approximately proportional to
ng.
10
Example
This example reads the set of univariate spectrum statistics, the two univariate spectra and the cross spectrum at a frequency division of $\frac{2\pi}{20}$ for a pair of time series. It calls g13cef to calculate the cross amplitude spectrum and squared coherency and their bounds and prints the results.
10.1
Program Text
Program Text (g13cefe.f90)
10.2
Program Data
Program Data (g13cefe.d)
10.3
Program Results
Program Results (g13cefe.r)