/
pyshbiasadmitcorr.html
104 lines (93 loc) · 7.51 KB
/
pyshbiasadmitcorr.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>SHTOOLS - Localized spectral analysis</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../css/sh.css">
<link rel="icon" type="image/vnd.microsoft.icon" href="../../images/favicon.ico">
</head>
<body>
<div class="main">
<p class="centeredimage"><img src="../../images/logo.jpg" width=894 height=135 alt="SHTOOLS --- Tools for working with spherical harmonics"></p>
<table class="menu">
<tbody>
<tr>
<td><a href="http://shtools.ipgp.fr/">HOME</a></td>
<td><a href="https://github.com/SHTOOLS/SHTOOLS/releases">DOWNLOAD</a></td>
<td class="selected"><a href="../../documentation.html">DOCUMENTATION</a></td>
<td><a href="../../faq.html">FAQ</a> </td>
</tr>
</tbody>
</table>
<p class="dir">
> <a href="../../../index.html" class="dir">Home</a> > <a href="../../documentation.html" class="dir">Documentation</a> > <a href="../../python-routines.html" class="dir">Python</a> > <a href="../../pylocalized.html" class="dir">Localized Spectral Analysis</a></p>
<h1 id="shbiasadmitcorr">SHBiasAdmitCorr</h1>
<p>Calculate the expected multitaper admittance and correlation spectra associated with the input global cross-power spectra of two functions.</p>
<h1 id="usage">Usage</h1>
<p><code>admit</code>, <code>corr</code> = pyshtools.SHAdmitCorr (<code>sgt</code>, <code>sgg</code>, <code>stt</code>, <code>tapers</code>, [<code>lmax</code>, <code>lwin</code>, <code>k</code>, <code>mtdef</code>, <code>taper_wt</code>])</p>
<h1 id="returns">Returns</h1>
<dl>
<dt><code>admit</code> : float, dimension (<code>lmax</code>-<code>lwin</code>+1)</dt>
<dd>The biased admittance spectrum obtained using the localized (cross-)power spectra of Sgt and Stt.
</dd>
<dt><code>corr</code> : float, dimension (<code>lmax</code>-<code>lwin</code>+1)</dt>
<dd>The biased correlation spectrum obtained using the localized (cross-)power spectra of Sgt, Stt, and Sgg.
</dd>
</dl>
<h1 id="parameters">Parameters</h1>
<dl>
<dt><code>sgt</code> : float, dimension (<code>lmaxin1</code>+1)</dt>
<dd>The global cross-power spectrum of the functions <code>G</code> and <code>T</code>.
</dd>
<dt><code>sgg</code> : float, dimension (<code>lmaxin2</code>+1)</dt>
<dd>The global power spectrum of the function <code>G</code>.
</dd>
<dt><code>stt</code> : float, dimension (<code>lmaxin3</code>+1)</dt>
<dd>The global power spectrum of the function <code>T</code>.
</dd>
<dt><code>tapers</code> : float, dimension (<code>lwinin</code>+1, <code>kin</code>)</dt>
<dd>The spherical harmonic coefficients of the spherical cap localizing windows. Each column corresponds to the non-zero coefficients of a single angular order. Since all that is important is the power spectrum of each window, the exact angular order is not important. These are generated by a call to <code>SHReturnTapers</code> or <code>SHReturnTapersM</code>.
</dd>
<dt><code>lmax</code> : optional, integer, default = min(<code>lmaxin1</code>, <code>lmaxin2</code>, <code>lmaxin3</code>)</dt>
<dd>The maximum spherical harmonic degree to use of the input spectra <code>sgt</code>, <code>sgg</code>, <code>stt</code>.
</dd>
<dt><code>lwin</code> : optional, integer, default = <code>lwinin</code></dt>
<dd>The spherical harmonic bandwidth of the localizing windows.
</dd>
<dt><code>k</code> : optional, integer, default = <code>kin</code></dt>
<dd>The number of localizing windows to use. Only the first <code>k</code> columns of <code>tapers</code> will be employed, which corresponds to the <code>k</code> best-concentrated localizing windows.
</dd>
<dt><code>mtdef</code> : optional, integer, default = 1</dt>
<dd><ol style="list-style-type: decimal">
<li>Calculate the biased multitaper cross-power spectra first, and use these to calculate the final admittance and correlation spectra. 2: Calculate an admittance and correlation spectrum using each individual taper, and then average these to get the final admittance and correlation spectra.</li>
</ol>
</dd>
<dt><code>taper_wt</code> : optional, float, dimension (<code>k</code>), default = -1</dt>
<dd>The weights to apply to each individual windowed spectral estimate. The weights must sum to unity and are obtained from <code>SHMTVarOpt</code>. The default specifies that taper weights are not used.
</dd>
</dl>
<h1 id="description">Description</h1>
<p>Given the global cross-power spectra <code>Sgt</code>, <code>Sgg</code> and <code>Stt</code> of two functions <code>G</code> and <code>T</code>, <code>SHBiasAdmitCorr</code> will calculate the expected multitaper admittance and correlation spectra associated with the two global functions. This routine expects as input a matrix containing the spherical harmonic coefficients of the localizing windows, which can be generated by a call to <code>SHReturnTapers</code> or <code>SHReturnTapersM</code>. Only the <code>k</code> best-concentrated localization windows will be employed when calculating the biased cross-power spectra. The maximum calculated degree of the output biased admittance and correlation spectra corresponds to <code>lmax-lwin</code>, as it is assumed that the input cross-power spectra beyond <code>lmax</code> are unknown, and not zero.</p>
<p>Two manners of calculating the localized admittance and correlation spectra are possible according to the value of the optional parameter <code>mtdef</code>. In case 1, the multitaper cross-power spectra of Sgt, Sgg, and Stt are first calculated, and from these, the admittance and correlation spectra are formed. In case 2, the biased admittance and correlation spectra are calculated for each individual taper, and these are then averaged to obtain the biased multitaper admittance and correlation spectra.</p>
<p>The default is to apply equal weights to each individual windowed estimate of the spectrum, but this can be modified when <code>mtdef</code> is 1 by specifying the weights in the optional argument <code>taper_wt</code>. The weights must sum to unity and can be calculated by <code>SHMTVarOpt</code>.</p>
<h1 id="references">References</h1>
<p>Wieczorek, M. A. and F. J. Simons, Minimum-variance multitaper spectral estimation on the sphere, J. Fourier Anal. Appl., 13, doi:10.1007/s00041-006-6904-1, 665-692, 2007.</p>
<p>Simons, F. J., F. A. Dahlen and M. A. Wieczorek, Spatiospectral concentration on the sphere, SIAM Review, 48, 504-536, doi:10.1137/S0036144504445765, 2006.</p>
<p>Wieczorek, M. A. and F. J. Simons, Localized spectral analysis on the sphere, Geophys. J. Int., 162, 655-675.</p>
<h1 id="see-also">See also</h1>
<p><a href="pyshbias.html">shbias</a>, <a href="pyshbiask.html">shbiask</a>, <a href="pyshreturntapers.html">shreturntapers</a>, <a href="pyshreturntapersm.html">shreturntapersm</a>, <a href="pyshmtvaropt.html">shmtvaropt</a></p>
<p class="dir">
> <a href="../../../index.html" class="dir">Home</a> > <a href="../../documentation.html" class="dir">Documentation</a> > <a href="../../python-routines.html" class="dir">Python</a> > <a href="../../pylocalized.html" class="dir">Localized Spectral Analysis</a></p>
<table class="footer2" summary = "SHTOOLS; Fortran and Python spherical harmonic transform software package">
<tbody>
<tr>
<td class="c1"><a href="http://www.ipgp.fr/">Institut de Physique du Globe de Paris</a></td>
<td class="c2"><a href="http://www.sorbonne-paris-cite.fr/index.php/en">University of Sorbonne Paris Cité</a></td>
<td class="c3">© 2016 <a href="https://github.com/SHTOOLS">SHTOOLS</a></td>
</tr>
</tbody>
</table>
</div>
</body>
</html>