NAG Library Routine Document

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

2

Specification

Fortran Interface

Subroutine g13cdf (

nxy, mtxy, pxy, mw, ish, pw, l, kc, xg, yg, ng, ifail)

Integer, Intent (In)	::	nxy, mtxy, mw, ish, l, kc
Integer, Intent (Inout)	::	ifail
Integer, Intent (Out)	::	ng
Real (Kind=nag_wp), Intent (In)	::	pxy, pw
Real (Kind=nag_wp), Intent (Inout)	::	xg(kc), yg(kc)

C Header Interface

#include <nagmk26.h>

void	g13cdf_ (const Integer nxy, const Integer mtxy, const double pxy, const Integer mw, const Integer ish, const double pw, const Integer l, const Integer kc, double xg[], double yg[], Integer ng, Integer ifail)

3

Description

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

f_{x y}^{*} (ω) = \frac{1}{2 π n} \{\sum_{t = 1}^{n} y_{t} \exp (i ω t)\} \times \{\sum_{t = 1}^{n} x_{t} \exp (- i ω t)\}

for frequency values

ω_{j} = \frac{2 π j}{K}

0 \leq ω_{j} \leq π

A correction is made for bias due to any tapering.

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

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

where [ ] denotes the integer part.

Its real part or co-spectrum

c f (ν_{l})

, and imaginary part or quadrature spectrum

q f (ν_{l})

are defined by

f_{x y} (ν_{l}) = c f (ν_{l}) + i q f (ν_{l}) = \sum_{|ω_{k}| < \frac{π}{M}} {\tilde{w}}_{k} f_{x y}^{*} (ν_{l} + ω_{k})

where the weights

{\tilde{w}}_{k}

are similar to the weights

w_{k}

defined for g13cbf, but allow for an implicit alignment shift

S

between the series:

{\tilde{w}}_{k} = w_{k} \exp (- 2 π i S k / L) .

It is recommended that

S

is chosen as the lag

k

at which the cross-covariances

c_{x y} (k)

peak, so as to minimize bias.

If no smoothing is required, the integer

M

, which determines the frequency window width

\frac{2 π}{M}

, should be set to

n

The bandwidth of the estimates will normally have been calculated in a previous call of g13cbf 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: 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.

Constraint:

0 \leq mtxy \leq 2

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

On entry: 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.

Constraint:

0.0 \leq pxy \leq 1.0

4: $mw$ – IntegerInput

On entry:

M

, the frequency width of the smoothing window as

\frac{2 π}{M}

A value of

n

implies that no smoothing is to be carried out.

Constraint:

1 \leq mw \leq nxy

5: $ish$ – IntegerInput

On entry:

S

, the alignment shift between the

x

and

y

series. If

x

leads

y

, the shift is positive.

Constraint:

- l < ish < l

6: $pw$ – Real (Kind=nag_wp)Input

On entry:

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.

mw = nxy

(i.e., no smoothing is carried out) then pw is not used.

Constraint: if

mw \neq nxy

0.0 \leq pw \leq 1.0

7: $l$ – IntegerInput

On entry:

L

, the frequency division of smoothed cross spectral estimates as

\frac{2 π}{L}

Constraints:

$l \geq 1$ ;
l must be a factor of kc.

8: $kc$ – IntegerInput

On entry: the dimension of the arrays xg and yg as declared in the (sub)program from which g13cdf is called. The order of the fast Fourier transform (FFT) used to calculate the spectral estimates.

Constraints:

$kc \geq 2 \times nxy$ ;
kc must be a multiple of l.

9: $xg (kc)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: the nxy data points of the

x

series.

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

xg (1)

xg (ng)

, and

xg (ng + 1)

xg (kc)

contain

0.0

. The

y

series leads the

x

series.

10: $yg (kc)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: the nxy data points of the

y

series.

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

yg (1)

yg (ng)

, and

yg (ng + 1)

yg (kc)

contain

0.0

. The

y

series leads the

x

series.

11: $ng$ – IntegerOutput

On exit: the number of spectral estimates,

[L / 2] + 1

, whose separate parts are held in xg and yg.

12: $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, $ish = 〈value〉$ and $l = 〈value〉$ .
Constraint: $|ish| < l$ .

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

On entry, $mtxy = 〈value〉$ .
Constraint: $mtxy \leq 2$ .

On entry, $mtxy = 〈value〉$ .
Constraint: $mtxy \geq 0$ .

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

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

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

On entry, $pxy = 〈value〉$ , $mw = 〈value〉$ and $nxy = 〈value〉$ .
Constraint: if $pw < 0.0$ , $mw = nxy$ .

On entry, $pxy = 〈value〉$ , $mw = 〈value〉$ and $nxy = 〈value〉$ .
Constraint: if $pw > 1.0$ , $mw = nxy$ .

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

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

$ifail = 2$: On entry, $kc = 〈value〉$ and $l = 〈value〉$ .
Constraint: kc must be a multiple of l.

On entry, $kc = 〈value〉$ and $nxy = 〈value〉$ .
Constraint: $kc \geq 2 \times nxy$ .

$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

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

g13cdf 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

g13cdf carries out an FFT of length kc to calculate the sample cross spectrum. The time taken by the routine for this is approximately proportional to

kc \times \log (kc)

(but see routine document c06paf for further details).

10

Example

This example reads two time series of length

296

. It selects mean correction and a 10% tapering proportion. It selects a

2 π / 16

frequency width of smoothing window, a window shape parameter of

0.5

and an alignment shift of

3

. It then calls g13cdf to calculate the smoothed sample cross spectrum and prints the results.

NAG Library Routine Document

g13cdf (multi_spectrum_daniell)

▸▿ 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