hide long namesshow long names
hide short namesshow short names
Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

NAG Toolbox: nag_tsa_multi_spectrum_daniell (g13cd)

Purpose

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

Syntax

[xg, yg, ng, ifail] = g13cd(nxy, mtxy, pxy, mw, ish, pw, l, xg, yg, 'kc', kc)
[xg, yg, ng, ifail] = nag_tsa_multi_spectrum_daniell(nxy, mtxy, pxy, mw, ish, pw, l, xg, yg, 'kc', kc)

Description

The supplied time series may be mean and trend corrected and tapered as in the description of nag_tsa_uni_spectrum_daniell (g13cb) before calculation of the unsmoothed sample cross-spectrum
fxy * (ω) = 1/(2πn)
(n )
ytexp(iωt)
t = 1
×
(n )
xtexp(iωt)
t = 1
fxy* (ω) = 12πn { t=1 n yt exp(iωt) } × { t=1 n xt exp(-iωt) }
for frequency values ωj = (2πj)/K ωj=2πjK , 0ωjπ0ωjπ.
A correction is made for bias due to any tapering.
As in the description of nag_tsa_uni_spectrum_daniell (g13cb) for univariate frequency window smoothing, the smoothed spectrum is returned as a subset of these frequencies,
νl = (2π l)/L,  l = 0,1,,[L / 2]
νl=2π lL,  l=0,1,,[L/2]
where [ ] denotes the integer part.
Its real part or co-spectrum cf(νl)cf(νl), and imaginary part or quadrature spectrum qf(νl)qf(νl) are defined by
fxy (νl) = cf (νl) + iqf (νl) = |ωk| < π/M k fxy * (νl + ωk)
fxy (νl) = cf (νl) + iqf (νl) = |ωk| < πM w~k fxy* (νl+ωk)
where the weights kw~k are similar to the weights wkwk defined for nag_tsa_uni_spectrum_daniell (g13cb), but allow for an implicit alignment shift SS between the series:
k = wkexp(2πiSk / L).
w~k=wkexp(-2π iSk/L).
It is recommended that SS is chosen as the lag kk at which the cross-covariances cxy(k)cxy(k) peak, so as to minimize bias.
If no smoothing is required, the integer MM, which determines the frequency window width (2π)/M 2πM , should be set to nn.
The bandwidth of the estimates will normally have been calculated in a previous call of nag_tsa_uni_spectrum_daniell (g13cb) for estimating the univariate spectra of ytyt and xtxt.

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

Parameters

Compulsory Input Parameters

1:     nxy – int64int32nag_int scalar
nn, the length of the time series xx and yy.
Constraint: nxy1nxy1.
2:     mtxy – int64int32nag_int scalar
Whether the data is to be initially mean or trend corrected.
mtxy = 0mtxy=0
For no correction.
mtxy = 1mtxy=1
For mean correction.
mtxy = 2mtxy=2
For trend correction.
Constraint: 0mtxy20mtxy2.
3:     pxy – double scalar
The proportion of the data (totalled over both ends) to be initially tapered by the split cosine bell taper.
A value of 0.00.0 implies no tapering.
Constraint: 0.0pxy1.00.0pxy1.0.
4:     mw – int64int32nag_int scalar
MM, the frequency width of the smoothing window as (2π)/M 2πM .
A value of nn implies that no smoothing is to be carried out.
Constraint: 1mwnxy1mwnxy.
5:     ish – int64int32nag_int scalar
SS, the alignment shift between the xx and yy series. If xx leads yy, the shift is positive.
Constraint: l < ish < l-l<ish<l.
6:     pw – double scalar
pp, the shape parameter of the trapezium frequency window.
A value of 0.00.0 gives a triangular window, and a value of 1.01.0 a rectangular window.
If mw = nxymw=nxy (i.e., no smoothing is carried out) then pw is not used.
Constraint: if mwnxymwnxy, 0.0pw1.00.0pw1.0.
7:     l – int64int32nag_int scalar
LL, the frequency division of smoothed cross spectral estimates as (2π)/L 2πL .
Constraints:
  • l1l1;
  • l must be a factor of kc.
8:     xg(kc) – double array
kc, the dimension of the array, must satisfy the constraint
  • kc2 × nxykc2×nxy
  • kc must be a multiple of l. The largest prime factor of kc must not exceed 1919, and the total number of prime factors of kc, counting repetitions, must not exceed 2020. These two restrictions are imposed by the internal FFT algorithm used
  • .
    The nxy data points of the xx series.
    9:     yg(kc) – double array
    kc, the dimension of the array, must satisfy the constraint
  • kc2 × nxykc2×nxy
  • kc must be a multiple of l. The largest prime factor of kc must not exceed 1919, and the total number of prime factors of kc, counting repetitions, must not exceed 2020. These two restrictions are imposed by the internal FFT algorithm used
  • .
    The nxy data points of the yy series.

    Optional Input Parameters

    1:     kc – int64int32nag_int scalar
    Default: The dimension of the arrays xg, yg. (An error is raised if these dimensions are not equal.)
    The dimension of the arrays xg and yg as declared in the (sub)program from which nag_tsa_multi_spectrum_daniell (g13cd) is called. The order of the fast Fourier transform ( FFT) used to calculate the spectral estimates. kc should be a product of small primes such as 2m2m where mm is the smallest integer such that 2m2n2m2n, provided m20m20.
    Constraints:
    • kc2 × nxykc2×nxy;
    • kc must be a multiple of l. The largest prime factor of kc must not exceed 1919, and the total number of prime factors of kc, counting repetitions, must not exceed 2020. These two restrictions are imposed by the internal FFT algorithm used.

    Input Parameters Omitted from the MATLAB Interface

    None.

    Output Parameters

    1:     xg(kc) – double array
    The real parts of the ng cross spectral estimates in elements xg(1)xg1 to xg(ng)xgng, and xg(ng + 1)xgng+1 to xg(kc)xgkc contain 0.00.0. The yy series leads the xx series.
    2:     yg(kc) – double array
    The imaginary parts of the ng cross spectral estimates in elements yg(1)yg1 to yg(ng)ygng, and yg(ng + 1)ygng+1 to yg(kc)ygkc contain 0.00.0. The yy series leads the xx series.
    3:     ng – int64int32nag_int scalar
    The number of spectral estimates, [L / 2] + 1[L/2]+1, whose separate parts are held in xg and yg.
    4:     ifail – int64int32nag_int scalar
    ifail = 0ifail=0 unless the function detects an error (see [Error Indicators and Warnings]).

    Error Indicators and Warnings

    Errors or warnings detected by the function:
      ifail = 1ifail=1
    On entry,nxy < 1nxy<1,
    ormtxy < 0mtxy<0,
    ormtxy > 2mtxy>2,
    orpxy < 0.0pxy<0.0,
    orpxy > 1.0pxy>1.0,
    ormw < 1mw<1,
    ormw > nxymw>nxy,
    orpw < 0.0pw<0.0 and mwnxymwnxy,
    orpw > 1.0pw>1.0 and mwnxymwnxy,
    orl < 1l<1,
    or|ish|l|ish|l.
      ifail = 2ifail=2
    On entry,kc < 2 × nxykc<2×nxy,
    orkc is not a multiple of l,
    orkc has a prime factor exceeding 1919,
    orkc has more than 2020 prime factors, counting repetitions.
      ifail = 3ifail=3
    This indicates that a serious error has occurred. Check all array subscripts in calls to nag_tsa_multi_spectrum_daniell (g13cd). Seek expert help.

    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.

    Further Comments

    nag_tsa_multi_spectrum_daniell (g13cd) carries out an FFT of length kc to calculate the sample cross spectrum. The time taken by the function for this is approximately proportional to kc × log(kc)kc×log(kc) (but see function document nag_sum_fft_realherm_1d (c06pa) for further details).

    Example

    function nag_tsa_multi_spectrum_daniell_example
    nxy = int64(296);
    mtxy = int64(1);
    pxy = 0.1;
    mw = int64(16);
    ish = int64(3);
    pw = 0.5;
    l = int64(80);
    xg = zeros(640, 1);
    xg(1:296) = ...
        [-0.109;0;0.178;0.339;0.373;0.441;0.461;0.348;0.127;-0.18;-0.588;-1.055;
         -1.421;-1.52;-1.302;-0.814;-0.475;-0.193;0.088;0.435;0.771;0.866;0.875;
         0.891;0.987;1.263;1.775;1.976;1.934;1.866;1.832;1.767;1.608;1.265;0.79;
         0.36;0.115;0.088;0.331;0.645;0.96;1.409;2.67;2.834;2.812;2.483;1.929;
         1.485;1.214;1.239;1.608;1.905;2.023;1.815;0.535;0.122;0.009;0.164;0.671;
         1.019;1.146;1.155;1.112;1.121;1.223;1.257;1.157;0.913;0.62;0.255;-0.28;
         -1.08;-1.551;-1.799;-1.825;-1.456;-0.944;-0.57;-0.431;-0.577;-0.96;-1.616;
         -1.875;-1.891;-1.746;-1.474;-1.201;-0.927;-0.524;0.04;0.788;0.943;0.93;
         1.006;1.137;1.198;1.054;0.595;-0.08;-0.314;-0.288;-0.153;-0.109;-0.187;
         -0.255;-0.299;-0.007;0.254;0.33;0.102;-0.423;-1.139;-2.275;-2.594;-2.716;
         -2.51;-1.79;-1.346;-1.081;-0.91;-0.876;-0.885;-0.8;-0.544;-0.416;-0.271;
         0;0.403;0.841;1.285;1.607;1.746;1.683;1.485;0.993;0.648;0.577;0.577;
         0.632;0.747;0.999;0.993;0.968;0.79;0.399;-0.161;-0.553;-0.603;-0.424;
         -0.194;-0.049;0.06;0.161;0.301;0.517;0.566;0.56;0.573;0.592;0.671;0.933;
         1.337;1.46;1.353;0.772;0.218;-0.237;-0.714;-1.099;-1.269;-1.175;-0.676;
         0.033;0.556;0.643;0.484;0.109;-0.31;-0.697;-1.047;-1.218;-1.183;-0.873;
         -0.336;0.063;0.084;0;0.001;0.209;0.556;0.782;0.858;0.918;0.862;0.416;
         -0.336;-0.959;-1.813;-2.378;-2.499;-2.473;-2.33;-2.053;-1.739;-1.261;
         -0.569;-0.137;-0.024;-0.05;-0.135;-0.276;-0.534;-0.871;-1.243;-1.439;
         -1.422;-1.175;-0.813;-0.634;-0.582;-0.625;-0.713;-0.848;-1.039;-1.346;
         -1.628;-1.619;-1.149;-0.488;-0.16;-0.007;-0.092;-0.62;-1.086;-1.525;
         -1.858;-2.029;-2.024;-1.961;-1.952;-1.794;-1.302;-1.03;-0.918;-0.798;
         -0.867;-1.047;-1.123;-0.876;-0.395;0.185;0.662;0.709;0.605;0.501;0.603;
         0.943;1.223;1.249;0.824;0.102;0.025;0.382;0.922;1.032;0.866;0.527;0.093;
         -0.458;-0.748;-0.947;-1.029;-0.928;-0.645;-0.424;-0.276;-0.158;-0.033;
         0.102;0.251;0.28;0;-0.493;-0.759;-0.824;-0.74;-0.528;-0.204;0.034;0.204;
         0.253;0.195;0.131;0.017;-0.182;-0.262];
    yg = zeros(640, 1);
    yg(1:296) = ...
        [53.8;53.6;53.5;53.5;53.4;53.1;52.7;52.4;52.2;52;52;52.4;53;54;54.9;56;56.8;
         56.8;56.4;55.7;55;54.3;53.2;52.3;51.6;51.2;50.8;50.5;50;49.2;48.4;47.9;
         47.6;47.5;47.5;47.6;48.1;49;50;51.1;51.8;51.9;51.7;51.2;50;48.3;47;45.8;
         45.6;46;46.9;47.8;48.2;48.3;47.9;47.2;47.2;48.1;49.4;50.6;51.5;51.6;51.2;
         50.5;50.1;49.8;49.6;49.4;49.3;49.2;49.3;49.7;50.3;51.3;52.8;54.4;56;56.9;
         57.5;57.3;56.6;56;55.4;55.4;56.4;57.2;58;58.4;58.4;58.1;57.7;57;56;54.7;
         53.2;52.1;51.6;51;50.5;50.4;51;51.8;52.4;53;53.4;53.6;53.7;53.8;53.8;53.8;
         53.3;53;52.9;53.4;54.6;56.4;58;59.4;60.2;60;59.4;58.4;57.6;56.9;56.4;56;
         55.7;55.3;55;54.4;53.7;52.8;51.6;50.6;49.4;48.8;48.5;48.7;49.2;49.8;50.4;
         50.7;50.9;50.7;50.5;50.4;50.2;50.4;51.2;52.3;53.2;53.9;54.1;54;53.6;53.2;
         53;52.8;52.3;51.9;51.6;51.6;51.4;51.2;50.7;50;49.4;49.3;49.7;50.6;51.8;53;
         54;55.3;55.9;55.9;54.6;53.5;52.4;52.1;52.3;53;53.8;54.6;55.4;55.9;55.9;
         55.2;54.4;53.7;53.6;53.6;53.2;52.5;52;51.4;51;50.9;52.4;53.5;55.6;58;59.5;
         60;60.4;60.5;60.2;59.7;59;57.6;56.4;55.2;54.5;54.1;54.1;54.4;55.5;56.2;57;
         57.3;57.4;57;56.4;55.9;55.5;55.3;55.2;55.4;56;56.5;57.1;57.3;56.8;55.6;55;
         54.1;54.3;55.3;56.4;57.2;57.8;58.3;58.6;58.8;58.8;58.6;58;57.4;57;56.4;
         56.3;56.4;56.4;56;55.2;54;53;52;51.6;51.6;51.1;50.4;50;50;52;54;55.1;54.5;
         52.8;51.4;50.8;51.2;52;52.8;53.8;54.5;54.9;54.9;54.8;54.4;53.7;53.3;52.8;
         52.6;52.6;53;54.3;56;57;58;58.6;58.5;58.3;57.8;57.3;57];
    [xgOut, ygOut, ng, ifail] = ...
             nag_tsa_multi_spectrum_daniell(nxy, mtxy, pxy, mw, ish, pw, l, xg, yg);
     ng, ifail
    
     
    
    ng =
    
                       41
    
    
    ifail =
    
                        0
    
    
    
    function g13cd_example
    nxy = int64(296);
    mtxy = int64(1);
    pxy = 0.1;
    mw = int64(16);
    ish = int64(3);
    pw = 0.5;
    l = int64(80);
    xg = zeros(640, 1);
    xg(1:296) = ...
        [-0.109;0;0.178;0.339;0.373;0.441;0.461;0.348;0.127;-0.18;-0.588;-1.055;
         -1.421;-1.52;-1.302;-0.814;-0.475;-0.193;0.088;0.435;0.771;0.866;0.875;
         0.891;0.987;1.263;1.775;1.976;1.934;1.866;1.832;1.767;1.608;1.265;0.79;
         0.36;0.115;0.088;0.331;0.645;0.96;1.409;2.67;2.834;2.812;2.483;1.929;
         1.485;1.214;1.239;1.608;1.905;2.023;1.815;0.535;0.122;0.009;0.164;0.671;
         1.019;1.146;1.155;1.112;1.121;1.223;1.257;1.157;0.913;0.62;0.255;-0.28;
         -1.08;-1.551;-1.799;-1.825;-1.456;-0.944;-0.57;-0.431;-0.577;-0.96;-1.616;
         -1.875;-1.891;-1.746;-1.474;-1.201;-0.927;-0.524;0.04;0.788;0.943;0.93;
         1.006;1.137;1.198;1.054;0.595;-0.08;-0.314;-0.288;-0.153;-0.109;-0.187;
         -0.255;-0.299;-0.007;0.254;0.33;0.102;-0.423;-1.139;-2.275;-2.594;-2.716;
         -2.51;-1.79;-1.346;-1.081;-0.91;-0.876;-0.885;-0.8;-0.544;-0.416;-0.271;
         0;0.403;0.841;1.285;1.607;1.746;1.683;1.485;0.993;0.648;0.577;0.577;
         0.632;0.747;0.999;0.993;0.968;0.79;0.399;-0.161;-0.553;-0.603;-0.424;
         -0.194;-0.049;0.06;0.161;0.301;0.517;0.566;0.56;0.573;0.592;0.671;0.933;
         1.337;1.46;1.353;0.772;0.218;-0.237;-0.714;-1.099;-1.269;-1.175;-0.676;
         0.033;0.556;0.643;0.484;0.109;-0.31;-0.697;-1.047;-1.218;-1.183;-0.873;
         -0.336;0.063;0.084;0;0.001;0.209;0.556;0.782;0.858;0.918;0.862;0.416;
         -0.336;-0.959;-1.813;-2.378;-2.499;-2.473;-2.33;-2.053;-1.739;-1.261;
         -0.569;-0.137;-0.024;-0.05;-0.135;-0.276;-0.534;-0.871;-1.243;-1.439;
         -1.422;-1.175;-0.813;-0.634;-0.582;-0.625;-0.713;-0.848;-1.039;-1.346;
         -1.628;-1.619;-1.149;-0.488;-0.16;-0.007;-0.092;-0.62;-1.086;-1.525;
         -1.858;-2.029;-2.024;-1.961;-1.952;-1.794;-1.302;-1.03;-0.918;-0.798;
         -0.867;-1.047;-1.123;-0.876;-0.395;0.185;0.662;0.709;0.605;0.501;0.603;
         0.943;1.223;1.249;0.824;0.102;0.025;0.382;0.922;1.032;0.866;0.527;0.093;
         -0.458;-0.748;-0.947;-1.029;-0.928;-0.645;-0.424;-0.276;-0.158;-0.033;
         0.102;0.251;0.28;0;-0.493;-0.759;-0.824;-0.74;-0.528;-0.204;0.034;0.204;
         0.253;0.195;0.131;0.017;-0.182;-0.262];
    yg = zeros(640, 1);
    yg(1:296) = ...
        [53.8;53.6;53.5;53.5;53.4;53.1;52.7;52.4;52.2;52;52;52.4;53;54;54.9;56;56.8;
         56.8;56.4;55.7;55;54.3;53.2;52.3;51.6;51.2;50.8;50.5;50;49.2;48.4;47.9;
         47.6;47.5;47.5;47.6;48.1;49;50;51.1;51.8;51.9;51.7;51.2;50;48.3;47;45.8;
         45.6;46;46.9;47.8;48.2;48.3;47.9;47.2;47.2;48.1;49.4;50.6;51.5;51.6;51.2;
         50.5;50.1;49.8;49.6;49.4;49.3;49.2;49.3;49.7;50.3;51.3;52.8;54.4;56;56.9;
         57.5;57.3;56.6;56;55.4;55.4;56.4;57.2;58;58.4;58.4;58.1;57.7;57;56;54.7;
         53.2;52.1;51.6;51;50.5;50.4;51;51.8;52.4;53;53.4;53.6;53.7;53.8;53.8;53.8;
         53.3;53;52.9;53.4;54.6;56.4;58;59.4;60.2;60;59.4;58.4;57.6;56.9;56.4;56;
         55.7;55.3;55;54.4;53.7;52.8;51.6;50.6;49.4;48.8;48.5;48.7;49.2;49.8;50.4;
         50.7;50.9;50.7;50.5;50.4;50.2;50.4;51.2;52.3;53.2;53.9;54.1;54;53.6;53.2;
         53;52.8;52.3;51.9;51.6;51.6;51.4;51.2;50.7;50;49.4;49.3;49.7;50.6;51.8;53;
         54;55.3;55.9;55.9;54.6;53.5;52.4;52.1;52.3;53;53.8;54.6;55.4;55.9;55.9;
         55.2;54.4;53.7;53.6;53.6;53.2;52.5;52;51.4;51;50.9;52.4;53.5;55.6;58;59.5;
         60;60.4;60.5;60.2;59.7;59;57.6;56.4;55.2;54.5;54.1;54.1;54.4;55.5;56.2;57;
         57.3;57.4;57;56.4;55.9;55.5;55.3;55.2;55.4;56;56.5;57.1;57.3;56.8;55.6;55;
         54.1;54.3;55.3;56.4;57.2;57.8;58.3;58.6;58.8;58.8;58.6;58;57.4;57;56.4;
         56.3;56.4;56.4;56;55.2;54;53;52;51.6;51.6;51.1;50.4;50;50;52;54;55.1;54.5;
         52.8;51.4;50.8;51.2;52;52.8;53.8;54.5;54.9;54.9;54.8;54.4;53.7;53.3;52.8;
         52.6;52.6;53;54.3;56;57;58;58.6;58.5;58.3;57.8;57.3;57];
    [xgOut, ygOut, ng, ifail] = g13cd(nxy, mtxy, pxy, mw, ish, pw, l, xg, yg);
     ng, ifail
    
     
    
    ng =
    
                       41
    
    
    ifail =
    
                        0
    
    
    

    PDF version (NAG web site, 64-bit version, 64-bit version)
    Chapter Contents
    Chapter Introduction
    NAG Toolbox

    © The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2013