/
pyshwindow.html
232 lines (182 loc) · 7.63 KB
/
pyshwindow.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
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>SHTOOLS - Python SHWindow Class</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="css/sh.css">
<link rel="shortcut icon" type="image/vnd.microsoft.icon" href="images/favicon.ico">
<link rel="icon" type="image/vnd.microsoft.icon" href="images/favicon.ico">
<meta name="description" content="Python classes defined by SHTOOLS.">
</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="pyclasses.html" class="dir">Classes</a></p>
<h1 class="nomarginbot extramargintop">SHWindow</h1>
<table class="pyclass">
<tbody>
<tr>
<td class="head">Subclasses</td>
</tr>
<tr>
<td class="left"><tt>SHWindowCap</tt></td>
<td class="right">Class for windows concentrated within a spherical cap.</td>
</tr>
<tr>
<td class="left"><tt>SHWindowMask</tt></td>
<td class="right">Class for windows concentrated in an arbitrary domain.</td>
</tr>
<tr>
<td class="head">Initialization</td>
</tr>
<tr>
<td class="left"><tt>x = SHWindow.from_cap()</tt></td>
<td class="right">Construct windows concentrated with a spherical cap.</td>
</tr>
<tr>
<td class="left"><tt>x = SHWindow.from_mask()</tt></td>
<td class="right">Construct windows concentrated with an arbitrary region.</td>
</tr>
<tr>
<td class="head">Attributes</td>
</tr>
<tr>
<td class="left"><tt>kind</tt></td>
<td class="right">Either <tt>'cap'</tt> or <tt>'mask'</tt>.</td>
</tr>
<tr>
<td class="left"><tt>coeffs</tt></td>
<td class="right">Array of spherical harmonic coefficients of the rotated spherical cap localization windows.</td>
</tr>
<tr>
<td class="left"><tt>eigenvalues</tt></td>
<td class="right">Concentration factors of the localization windows.</td>
</tr>
<tr>
<td class="left"><tt>orders</tt></td>
<td class="right">The angular orders for each of the spherical cap localization windows.</td>
</tr>
<tr>
<td class="left"><tt>weights</tt></td>
<td class="right">Taper weights used with the multitaper spectral analyses. Defaut is <tt>None</tt>.</td>
</tr>
<tr>
<td class="left"><tt>lmax</tt></td>
<td class="right">Spherical harmonic bandwidth of the localization windows.</td>
</tr>
<tr>
<td class="left"><tt>theta</tt></td>
<td class="right">Angular radius of the spherical cap localization domain (default in degrees).</td>
</tr>
<tr>
<td class="left"><tt>theta_degrees</tt></td>
<td class="right"><tt>True</tt> (default) if theta is in degrees.</td>
</tr>
<tr>
<td class="left"><tt>nwin</tt></td>
<td class="right">Number of localization windows. Default is <tt>(lmax+1)**2</tt></td>
</tr>
<tr>
<td class="left"><tt>clat, clon</tt></td>
<td class="right">Latitude and longitude of the center of the rotated spherical cap localization windows (default in degrees).</td>
</tr>
<tr>
<td class="left"><tt>coord_degrees</tt></td>
<td class="right"><tt>True</tt> (default) if <tt>clat</tt> and <tt>clon</tt> are in degrees.</td>
</tr>
<tr>
<td class="head">Methods</td>
</tr>
<tr>
<td class="left"><tt>get_coeffs()</tt></td>
<td class="right">Return an array of the spherical harmonic coefficients for taper <tt>i</tt>, where <tt>i=0</tt> is the best concentrated, optionally using a different normalization convention.</td>
</tr>
<tr>
<td class="left"><tt>get_degrees()</tt></td>
<td class="right">Return an array containing the spherical harmonic degrees of the localization windows, from <tt>0</tt> to <tt>lmax</tt>.</td>
</tr>
<tr>
<td class="left"><tt>get_powerperdegree()</tt></td>
<td class="right">Return the power per degree spectra for one or more of the localization windows.</td>
</tr>
<tr>
<td class="left"><tt>get_k()</tt></td>
<td class="right">Return the number of localization windows that have concentration factors greater or equal to a specified value.</td>
</tr>
<tr>
<td class="left"><tt>get_couplingmatrix()</tt></td>
<td class="right">Return the coupling matrix of the first <tt>nwin</tt> tapers.</td>
</tr>
<tr>
<td class="left"><tt>get_biasedpowerspectrum()</tt></td>
<td class="right">Calculate the multitaper (cross-)power spectrum expectation of a localized function.</td>
</tr>
<tr>
<td class="left"><tt>get_grid()</tt></td>
<td class="right">Return as an array a grid of taper <tt>i</tt>, where <tt>i=0</tt> is the best concentrated window.</td>
</tr>
<tr>
<td class="left"><tt>get_multitaperpowerspectrum()</tt></td>
<td class="right">Return the multitaper power spectrum estimate and uncertainty for the input <tt>SHCoeffs</tt> class instance.</td>
</tr>
<tr>
<td class="left"><tt>get_multitapercrosspowerspectrum()</tt></td>
<td class="right">Return the multitaper cross-power spectrum estimate and uncertainty for two input <tt>SHCoeffs</tt> class instances.</td>
</tr>
<tr>
<td class="left"><tt>return_coeffs()</tt></td>
<td class="right">Return the spherical harmonic coefficients of taper <tt>i</tt>, where <tt>i=0</tt> is the best concentrated, as a new <tt>SHCoeffs</tt> class instance, optionally using a different normalization convention.</td>
</tr>
<tr>
<td class="left"><tt>return_grid()</tt></td>
<td class="right">Return as a new <tt>SHGrid</tt> instance a grid of taper <tt>i</tt>, where <tt>i=0</tt> is the best concentrated window.</td>
</tr>
<tr>
<td class="left"><tt>rotate()</tt></td>
<td class="right">Rotate the spherical cap tapers, originally located at the north pole, to <tt>clat</tt> and <tt>clon</tt> and save the spherical harmonic coefficients in <tt>coeffs</tt>.</td>
</tr>
<tr>
<td class="left"><tt>plot_windows()</tt></td>
<td class="right">Plot the best concentrated localization windows using a simple cylindrical projection.</td>
</tr>
<tr>
<td class="left"><tt>plot_powerperdegree()</tt></td>
<td class="right">Plot the power spectra of the best concentrated localization windows.</td>
</tr>
<tr>
<td class="left"><tt>plot_couplingmatrix()</tt></td>
<td class="right">Plot the multitaper coupling matrix.</td>
</tr>
<tr>
<td class="left"><tt>info()</tt></td>
<td class="right">Print a summary of the data stored in the <tt>SHWindow</tt> instance.</td>
</tr>
</tbody>
</table>
<br>
<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="pyclasses.html" class="dir">Classes</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>