-
Notifications
You must be signed in to change notification settings - Fork 104
/
shbiask.3
137 lines (137 loc) · 4.87 KB
/
shbiask.3
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "shbiask" "1" "2021-02-15" "Fortran 95" "SHTOOLS 4.11"
.hy
.SH SHBiasK
.PP
Calculate the multitaper (cross-)power spectrum expectation of a
function localized by spherical cap windows.
.SH Usage
.PP
call SHBiasK (\f[V]tapers\f[R], \f[V]lwin\f[R], \f[V]k\f[R],
\f[V]incspectra\f[R], \f[V]ldata\f[R], \f[V]outcspectra\f[R],
\f[V]taper_wt\f[R], \f[V]save_cg\f[R], \f[V]exitstatus\f[R])
.SH Parameters
.TP
\f[V]tapers\f[R] : input, real(dp), dimension (\f[V]lwin\f[R]+1, \f[V]k\f[R])
The spherical harmonic coefficients of the localization windows.
Each column corresponds to the non-zero coefficients of a single angular
order.
Since all that is necessary is the power spectrum of each window, the
exact angular order is not required.
These are generated by a call to \f[V]SHReturnTapers\f[R] or
\f[V]SHReturnTapersM\f[R].
.TP
\f[V]lwin\f[R] : input, integer(int32)
The spherical harmonic bandwidth of the localization windows.
.TP
\f[V]k\f[R] : input, integer(int32)
The number of localization windows to use.
Only the first \f[V]k\f[R] columns of \f[V]tapers\f[R] will be employed,
which corresponds to the best-concentrated windows.
.TP
\f[V]incspectra\f[R] : input, real(dp), dimension (\f[V]ldata\f[R]+1)
The global unwindowed power spectrum.
.TP
\f[V]ldata\f[R] : input, integer(int32)
The maximum degree of the global unwindowed power spectrum.
.TP
\f[V]outcspectra\f[R] : output, real(dp), dimension (\f[V]ldata\f[R]+\f[V]lwin\f[R]+1)
The expectation of the localized multitaper power spectrum.
.TP
\f[V]taper_wt\f[R] : input, optional, real(dp), dimension (\f[V]k\f[R])
The weights to apply to each individual windowed spectral estimate.
The weights must sum to unity and are obtained from
\f[V]SHMTVarOpt\f[R].
.TP
\f[V]save_cg\f[R] : input, optional, integer(int32), default = 0
If set equal to 1, the Clebsch-Gordon coefficients will be precomputed
and saved for future use (if \f[V]lwin\f[R] or \f[V]ldata\f[R] change,
these will be recomputed).
To deallocate the saved memory, set this parameter equal to 1.
If set equal to 0 (default), the Clebsch-Gordon coefficients will be
recomputed for each call.
.TP
\f[V]exitstatus\f[R] : output, optional, integer(int32)
If present, instead of executing a STOP when an error is encountered,
the variable exitstatus will be returned describing the error.
0 = No errors; 1 = Improper dimensions of input array; 2 = Improper
bounds for input variable; 3 = Error allocating memory; 4 = File IO
error.
.SH Description
.PP
\f[V]SHBiasK\f[R] will calculate the multitaper (cross-)power spectrum
expectation of a function multiplied by the \f[V]k\f[R]
best-concentrated spherical-cap localization windows.
This is given by equation 36 of Wieczorek and Simons (2005) (see also
eq.
2.11 of Wieczorek and Simons 2007).
In contrast to \f[V]SHBias\f[R], which takes as input the power spectrum
of a single localizing window, this routine expects as input a matrix
containing the spherical harmonic coefficients of the windows.
These can be generated by a call to \f[V]SHReturnTapers\f[R] or
\f[V]SHReturnTapersM\f[R].
.PP
The maximum calculated degree of the windowed power spectrum expectation
corresponds to the smaller of (\f[V]ldata\f[R]+\f[V]lwin\f[R]) and
\f[V]size(outcspectra)-1\f[R].
It is assumed implicitly that the power spectrum of \f[V]inspectrum\f[R]
is zero beyond degree \f[V]ldata\f[R].
If this is not the case, the ouput power spectrum should be considered
valid only for the degrees up to and including \f[V]ldata\f[R] -
\f[V]lwin\f[R].
Note that this routine will only work when the window coefficients are
non-zero for a single angular order.
.PP
The default is to apply equal weights to each individual windowed
estimate of the spectrum, but this can be modified by specifying the
weights in the optional argument \f[V]taper_wt\f[R].
The weights must sum to unity.
If this routine is to be called several times using the same values of
\f[V]lwin\f[R] and \f[V]ldata\f[R], then the Clebsch-Gordon coefficients
can be precomputed and saved by setting the optional parameter
\f[V]save_cg\f[R] equal to 1.
.SH References
.PP
Wieczorek, M.
A.
and F.
J.
Simons, Minimum-variance multitaper spectral estimation on the sphere,
J.
Fourier Anal.
Appl., 13, 665-692, doi:10.1007/s00041-006-6904-1, 2007.
.PP
Simons, F.
J., F.
A.
Dahlen and M.
A.
Wieczorek, Spatiospectral concentration on a sphere, SIAM Review, 48,
504-536, doi:10.1137/S0036144504445765, 2006.
.PP
Wieczorek, M.
A.
and F.
J.
Simons, Localized spectral analysis on the sphere, Geophys.
J.
Int., 162, 655-675, doi:10.1111/j.1365-246X.2005.02687.x, 2005.
.SH See also
.PP
shbias, shmtvaropt, shreturntapers, shreturntapersm, shmtvaropt,
shbiasadmitcorr, shmtcouplingmatrix