NAG Library ManualKeyword Search:

NAG Library Routine Document

g13ccf (multi_spectrum_lag)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

g13ccf calculates the smoothed sample cross spectrum of a bivariate time series using one of four lag windows: rectangular, Bartlett, Tukey or Parzen.

2

Specification

Fortran Interface

Subroutine g13ccf (

nxy, mtxy, pxy, iw, mw, ish, ic, nc, cxy, cyx, kc, l, nxyg, xg, yg, ng, ifail)

Integer, Intent (In)	::	nxy, mtxy, iw, mw, ish, ic, nc, kc, l, nxyg
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	ng
Real (Kind=nag_wp), Intent (In)	::	pxy
Real (Kind=nag_wp), Intent (Inout)	::	cxy(nc), cyx(nc), xg(nxyg), yg(nxyg)

C Header Interface

#include nagmk26.h

void

g13ccf_ ( const Integer *nxy, const Integer *mtxy, const double *pxy, const Integer *iw, const Integer *mw, const Integer *ish, const Integer *ic, const Integer *nc, double cxy[], double cyx[], const Integer *kc, const Integer *l, const Integer *nxyg, double xg[], double yg[], Integer *ng, Integer *ifail)

3

Description

The smoothed sample cross spectrum is a complex valued function of frequency

ω

f_{x y} (ω) = c f (ω) + i q f (ω)

, defined by its real part or co-spectrum

c f (ω) = \frac{1}{2 π} \sum_{k = - M + 1}^{M - 1} w_{k} C_{x y} (k + S) \cos (ω k)

and imaginary part or quadrature spectrum

q f (ω) = \frac{1}{2 π} \sum_{k = - M + 1}^{M - 1} w_{k} C_{x y} (k + S) \sin (ω k)

where

w_{k} = w_{- k}

, for

k = 0, 1, \dots, M - 1

, is the smoothing lag window as defined in the description of g13caf. The alignment shift

S

is recommended to be chosen as the lag

k

at which the cross-covariances

c_{x y} (k)

peak, so as to minimize bias.

The results are calculated for frequency values

ω_{j} = \frac{2 π j}{L}, j = 0, 1, \dots, [L / 2],

where

[]

denotes the integer part.

The cross-covariances

c_{x y} (k)

may be supplied by you, or constructed from supplied series

x_{1}, x_{2}, \dots, x_{n}

;

y_{1}, y_{2}, \dots, y_{n}

c_{x y} (k) = \frac{\sum_{t = 1}^{n - k} x_{t} y_{t + k}}{n}, k \geq 0

c_{x y} (k) = \frac{\sum_{t = 1 - k}^{n} x_{t} y_{t + k}}{n} = c_{y x} (- k), k < 0

this convolution being carried out using the finite Fourier transform.

The supplied series may be mean and trend corrected and tapered before calculation of the cross-covariances, in exactly the manner described in g13caf for univariate spectrum estimation. The results are corrected for any bias due to tapering.

The bandwidth associated with the estimates is not returned. It will normally already have been calculated in previous calls of g13caf for estimating the univariate spectra of

y_{t}

and

x_{t}

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: $nxy$ – IntegerInput

On entry:

n

, the length of the time series

x

and

y

Constraint:

nxy \geq 1

2: $mtxy$ – IntegerInput

On entry: if cross-covariances are to be calculated by the routine (

ic = 0

), mtxy must specify 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.

If cross-covariances are supplied

(ic \neq 0)

, mtxy is not used.

Constraint: if

ic = 0

mtxy = 0

1

2

3: $pxy$ – Real (Kind=nag_wp)Input

On entry: if cross-covariances are to be calculated by the routine (

ic = 0

), pxy must specify 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.

If cross-covariances are supplied

(ic \neq 0)

, pxy is not used.

Constraint: if

ic = 0

0.0 \leq pxy \leq 1.0

4: $iw$ – IntegerInput

On entry: the choice of lag window.

$iw = 1$: Rectangular.
$iw = 2$: Bartlett.
$iw = 3$: Tukey.
$iw = 4$: Parzen.

Constraint:

1 \leq iw \leq 4

5: $mw$ – IntegerInput

On entry:

M

, the ‘cut-off’ point of the lag window, relative to any alignment shift that has been applied. Windowed cross-covariances at lags

(- mw + ish)

or less, and at lags

(mw + ish)

or greater are zero.

Constraints:

$mw \geq 1$ ;
$mw + |ish| \leq nxy$ .

6: $ish$ – IntegerInput

On entry:

S

, the alignment shift between the

x

and

y

series. If

x

leads

y

, the shift is positive.

Constraint:

- mw < ish < mw

7: $ic$ – IntegerInput

On entry: indicates whether cross-covariances are to be calculated in the routine or supplied in the call to the routine.

$ic = 0$: Cross-covariances are to be calculated.
$ic \neq 0$: Cross-covariances are to be supplied.

8: $nc$ – IntegerInput

On entry: the number of cross-covariances to be calculated in the routine or supplied in the call to the routine.

Constraint:

mw + |ish| \leq nc \leq nxy

9: $cxy (nc)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: if

ic \neq 0

, cxy must contain the nc cross-covariances between values in the

y

series and earlier values in time in the

x

series, for lags from

0

(nc - 1)

ic = 0

, cxy need not be set.

On exit: if

ic = 0

, cxy will contain the nc calculated cross-covariances.

ic \neq 0

, the contents of cxy will be unchanged.

10: $cyx (nc)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: if

ic \neq 0

, cyx must contain the nc cross-covariances between values in the

y

series and later values in time in the

x

series, for lags from

0

(nc - 1)

ic = 0

, cyx need not be set.

On exit: if

ic = 0

, cyx will contain the nc calculated cross-covariances.

ic \neq 0

, the contents of cyx will be unchanged.

11: $kc$ – IntegerInput

On entry: if

ic = 0

, kc must specify the order of the fast Fourier transform (FFT) used to calculate the cross-covariances.

ic \neq 0

, that is if covariances are supplied, kc is not used.

Constraint:

kc \geq nxy + nc

12: $l$ – IntegerInput

On entry:

L

, the frequency division of the spectral estimates as

\frac{2 π}{L}

. Therefore it is also the order of the FFT used to construct the sample spectrum from the cross-covariances.

Constraint:

l \geq 2 \times mw - 1

13: $nxyg$ – IntegerInput

On entry: the dimension of the arrays xg and yg as declared in the (sub)program from which g13ccf is called.

Constraints:

if $ic = 0$ , $nxyg \geq \max (kc, l)$ ;
otherwise $nxyg \geq l$ .

14: $xg (nxyg)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: if the cross-covariances are to be calculated, then xg must contain the nxy data points of the

x

series. If covariances are supplied, xg need not be set.

On exit: contains the real parts of the ng complex spectral estimates in elements

xg (1)

xg (ng)

, and

xg (ng + 1)

xg (nxyg)

contain

0.0

. The

y

series leads the

x

series.

15: $yg (nxyg)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: if cross-covariances are to be calculated, yg must contain the nxy data points of the

y

series. If covariances are supplied, yg need not be set.

On exit: contains the imaginary parts of the ng complex spectral estimates in elements

yg (1)

yg (ng)

, and

yg (ng + 1)

yg (nxyg)

contain

0.0

. The

y

series leads the

x

series.

16: $ng$ – IntegerOutput

On exit: the number,

[l / 2] + 1

, of complex spectral estimates, whose separate parts are held in xg and yg.

17: $ifail$ – IntegerInput/Output

On entry: ifail must be set to

0

- 1 ​ 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 ​ 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 $- 1 or 1$ is used it is essential to test the value of ifail on exit.

On exit:

ifail = 0

unless the routine detects an error or a warning has been flagged (see Section 6).

6

Error Indicators and Warnings

If on entry

ifail = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

$ifail = 1$: On entry, $ic = 〈value〉$ , $nxyg = 〈value〉$ and $l = 〈value〉$ .
Constraint: if $ic \neq 0$ , $nxyg \geq l$ .

On entry, $ish = 〈value〉$ and $mw = 〈value〉$ .
Constraint: $|ish| \leq mw$ .

On entry, $iw = 〈value〉$ .
Constraint: $iw = 1$ , $2$ , $3$ or $4$ .

On entry, $mtxy = 〈value〉$ .
Constraint: if $ic = 0$ then $mtxy \neq 0$ , $1$ or $2$ .

On entry, $mw = 〈value〉$ , $ish = 〈value〉$ and $nxy = 〈value〉$ .
Constraint: $mw + |ish| \leq nxy$ .

On entry, $mw = 〈value〉$ .
Constraint: $mw \geq 1$ .

On entry, $nc = 〈value〉$ , $mw = 〈value〉$ and $ish = 〈value〉$ .
Constraint: $nc \geq mw + |ish|$ .

On entry, $nc = 〈value〉$ and $nxy = 〈value〉$ .
Constraint: $nc \leq nxy$ .

On entry, $nxy = 〈value〉$ .
Constraint: $nxy \geq 1$ .

On entry, $nxyg = 〈value〉$ , $kc = 〈value〉$ and $l = 〈value〉$ .
Constraint: if $ic = 0$ , $nxyg \geq \max (kc, l)$ .

On entry, $pxy = 〈value〉$ .
Constraint: if $ic = 0$ , $pxy \geq 0.0$ .

On entry, $pxy = 〈value〉$ .
Constraint: if $ic = 0$ , $pxy \leq 1.0$ .

$ifail = 2$: On entry, $kc = 〈value〉$ , $nxy = 〈value〉$ and $nc = 〈value〉$ .
Constraint: if $ic = 0$ , $kc \geq nxy + nc$ .

$ifail = 3$: On entry, $l = 〈value〉$ and $mw = 〈value〉$ .
Constraint: $l \geq 2 \times mw - 1$ .

$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.

$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.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

The FFT is a numerically stable process, and any errors introduced during the computation will normally be insignificant compared with uncertainty in the data.

8

Parallelism and Performance

g13ccf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.

g13ccf makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.

Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9

Further Comments

g13ccf carries out two FFTs of length kc to calculate the sample cross-covariances and one FFT of length

L

to calculate the sample spectrum. The timing of g13ccf is therefore dependent on the choice of these values. The time taken for an FFT of length

n

is approximately proportional to

n \log (n)

(but see Section 9 in c06paf for further details).

10

Example

This example reads two time series of length

296

. It then selects mean correction, a 10% tapering proportion, the Parzen smoothing window and a cut-off point of

35

for the lag window. The alignment shift is set to

3

and

50

cross-covariances are chosen to be calculated. The program then calls g13ccf to calculate the cross spectrum and then prints the cross-covariances and cross spectrum.

NAG Library Routine Document

g13ccf (multi_spectrum_lag)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

6

Error Indicators and Warnings

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

10.2

Program Data

10.3

Program Results