/
pyshpowerspectrumc.html
73 lines (62 loc) · 3.49 KB
/
pyshpowerspectrumc.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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>SHTOOLS - Global 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="../../pygspectra.html" class="dir">Global Spectral Analysis</a></p>
<h1 id="shpowerspectrumc">SHPowerSpectrumC</h1>
<p>Compute the power spectrum of a complex function.</p>
<h1 id="usage">Usage</h1>
<p><code>pspectrum</code> = pyshtools.SHPowerSpectrumC (<code>cilm</code>, [<code>lmax</code>])</p>
<h1 id="returns">Returns</h1>
<dl>
<dt><code>pspectrum</code> : float, dimension (<code>lmax</code>+1)</dt>
<dd>The power spectrum of the complex function.
</dd>
</dl>
<h1 id="parameters">Parameters</h1>
<dl>
<dt><code>cilm</code> : complex, dimension (2, <code>lmaxin</code>+1, <code>lmaxin</code>+1)</dt>
<dd>The complex function expressed in complex spherical harmonics.
</dd>
<dt><code>lmax</code> : optional, integer, default = <code>lmaxin</code></dt>
<dd>The maximum spherical harmonic degree of the power spectrum. This must be less than or equal to <code>lmaxin</code>.
</dd>
</dl>
<h1 id="description">Description</h1>
<p><code>SHPowerSpectrumC</code> will calculate the power spectrum of a complex function expressed in complex spherical harmonics. For a given spherical harmonic degree <code>l</code>, this is calculated as:</p>
<p><code>pspectrum(l) = Sum_{i=0}^1 Sum_{m=0}^l | cilm[i, l, m] |**2</code>.</p>
<h1 id="see-also">See also</h1>
<p><a href="pyshpowerlc.html">shpowerlc</a>, <a href="pyshpowerdensitylc.html">shpowerdensitylc</a>, <a href="pyshcrosspowerlc.html">shcrosspowerlc</a>, <a href="pyshcrosspowerdensitylc.html">shcrosspowerdensitylc</a>, <a href="pyshpowerspectrumdensityc.html">shpowerspectrumdensityc</a>, <a href="pyshcrosspowerspectrumc.html">shcrosspowerspectrumc</a>, <a href="pyshcrosspowerspectrumdensityc.html">shcrosspowerspectrumdensityc</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="../../pygspectra.html" class="dir">Global 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>