naginterfaces.library.tsa.multi_​spectrum_​daniell

naginterfaces.library.tsa.multi_spectrum_daniell(nxy, mtxy, pxy, mw, ish, pw, l, xg, yg)

multi_spectrum_daniell calculates the smoothed sample cross spectrum of a bivariate time series using spectral smoothing by the trapezium frequency (Daniell) window.

For full information please refer to the NAG Library document for g13cd

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/g13/g13cdf.html

Parameters

nxyint

$n$, the length of the time series $x$ and $y$.

mtxyint

Whether the data is to be initially mean or trend corrected.

$mtxy=0$

For no correction.

$mtxy=1$

For mean correction.

$mtxy=2$

For trend correction.

pxyfloat

The proportion of the data (totalled over both ends) to be initially tapered by the split cosine bell taper.

A value of $0.0$ implies no tapering.

mwint

$M$, the frequency width of the smoothing window as $\frac{2\pi }{M}$.

A value of $n$ implies that no smoothing is to be carried out.

ishint

$S$, the alignment shift between the $x$ and $y$ series. If $x$ leads $y$, the shift is positive.

pwfloat

$p$, the shape parameter of the trapezium frequency window.

A value of $0.0$ gives a triangular window, and a value of $1.0$ a rectangular window.

If $mw=nxy$ (i.e., no smoothing is carried out) then $pw$ is not used.

lint

$L$, the frequency division of smoothed cross spectral estimates as $\frac{2\pi }{L}$.

xgfloat, array-like, shape $\left(\text{kc}\right)$

The $nxy$ data points of the $x$ series.

ygfloat, array-like, shape $\left(\text{kc}\right)$

The $nxy$ data points of the $y$ series.

Returns

xgfloat, ndarray, shape $\left(\text{kc}\right)$

The real parts of the $ng$ cross spectral estimates in elements $xg\left[0\right]$ to $xg[ng-1]$, and $xg\left[ng\right]$ to $xg[\text{kc}-1]$ contain $0.0$. The $y$ series leads the $x$ series.

ygfloat, ndarray, shape $\left(\text{kc}\right)$

The imaginary parts of the $ng$ cross spectral estimates in elements $yg\left[0\right]$ to $yg[ng-1]$, and $yg\left[ng\right]$ to $yg[\text{kc}-1]$ contain $0.0$. The $y$ series leads the $x$ series.

ngint

The number of spectral estimates, $\left[L/2\right]+1$, whose separate parts are held in $xg$ and $yg$.

Raises

NagValueError

(errno $1$)

On entry, $ish=⟨value⟩$ and $l=⟨value⟩$.

Constraint: $\left|ish\right|<l$.

(errno $1$)

On entry, $l=⟨value⟩$.

Constraint: $l\ge 1$.

(errno $1$)

On entry, $pxy=⟨value⟩$, $mw=⟨value⟩$ and $nxy=⟨value⟩$.

Constraint: if $pw>1.0$, $mw=nxy$.

(errno $1$)

On entry, $pxy=⟨value⟩$, $mw=⟨value⟩$ and $nxy=⟨value⟩$.

Constraint: if $pw<0.0$, $mw=nxy$.

(errno $1$)

On entry, $mw=⟨value⟩$ and $nxy=⟨value⟩$.

Constraint: $mw\le nxy$.

(errno $1$)

On entry, $mw=⟨value⟩$.

Constraint: $mw\ge 1$.

(errno $1$)

On entry, $pxy=⟨value⟩$.

Constraint: $pxy\le 1.0$.

(errno $1$)

On entry, $pxy=⟨value⟩$.

Constraint: $pxy\ge 0.0$.

(errno $1$)

On entry, $mtxy=⟨value⟩$.

Constraint: $mtxy\le 2$.

(errno $1$)

On entry, $mtxy=⟨value⟩$.

Constraint: $mtxy\ge 0$.

(errno $1$)

On entry, $nxy=⟨value⟩$.

Constraint: $nxy\ge 1$.

(errno $2$)

On entry, $\text{kc}=⟨value⟩$ and $l=⟨value⟩$.

Constraint: $\text{kc}$ must be a multiple of $l$.

(errno $2$)

On entry, $\text{kc}=⟨value⟩$ and $nxy=⟨value⟩$.

Constraint: $\text{kc}\ge 2\times nxy$.

Notes

In the NAG Library the traditional C interface for this routine uses a different algorithmic base. Please contact NAG if you have any questions about compatibility.

The supplied time series may be mean and trend corrected and tapered as in the description of uni_spectrum_daniell() before calculation of the unsmoothed sample cross-spectrum

$$f_{xy}^{\ast }\left(\omega \right)=\frac{1}{2\pi n}\left\{\sum _{t=1}^n{y}_{t}exp\left(i\omega t\right)\right\}\times \left\{\sum _{t=1}^n{x}_{t}exp(-i\omega t)\right\}$$

for frequency values ${\omega }_j=\frac{2\pi j}{K}$, $0\le {\omega }_j\le \pi$.

A correction is made for bias due to any tapering.

As in the description of uni_spectrum_daniell() for univariate frequency window smoothing, the smoothed spectrum is returned as a subset of these frequencies,

$${\nu }_l=\frac{2\pi l}{L}\text{,}l=0,1,\dots ,\left[L/2\right]$$

where [ ] denotes the integer part.

Its real part or co-spectrum $cf\left({\nu }_l\right)$, and imaginary part or quadrature spectrum $qf\left({\nu }_l\right)$ are defined by

$$f_{xy}\left({\nu }_l\right)=cf\left({\nu }_l\right)+iqf\left({\nu }_l\right)=\sum _{\left|{\omega }_k\right|<\frac{\pi }{M}}{\tilde{w}}_k{f}_{xy}^{\ast }({\nu }_l+{\omega }_k)$$

where the weights ${\tilde{w}}_k$ are similar to the weights $w_k$ defined for uni_spectrum_daniell(), but allow for an implicit alignment shift $S$ between the series:

$${\tilde{w}}_k=w_{k}exp(-2\pi iSk/L)\text{.}$$

It is recommended that $S$ is chosen as the lag $k$ at which the cross-covariances $c_{xy}\left(k\right)$ peak, so as to minimize bias.

If no smoothing is required, the integer $M$, which determines the frequency window width $\frac{2\pi }{M}$, should be set to $n$.

The bandwidth of the estimates will normally have been calculated in a previous call of uni_spectrum_daniell() for estimating the univariate spectra of $y_t$ and $x_t$.

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