/
pyshadmitcorr.html
81 lines (70 loc) · 4.51 KB
/
pyshadmitcorr.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
<!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="shadmitcorr">SHAdmitCorr</h1>
<p>Calculate the admittance and correlation spectra of two real functions.</p>
<h1 id="usage">Usage</h1>
<p><code>admit</code>, <code>error</code>, <code>corr</code> = pyshtools.SHAdmitCorr (<code>gilm</code>, <code>tilm</code>, [<code>lmax</code>])</p>
<h1 id="returns">Returns</h1>
<dl>
<dt><code>admit</code> : float, dimension (<code>lmax</code>+1)</dt>
<dd>The admittance function, which is equal to <code>Sgt/Stt</code>.
</dd>
<dt><code>error</code> : float, dimension (<code>lmax</code>+1)</dt>
<dd>The uncertainty of the admittance function, assuming that <code>gilm</code> and <code>tilm</code> are related by a linear isotropic transfer function, and that the lack of correlation is a result of uncorrelated noise.
</dd>
<dt><code>corr</code> : float, dimension (<code>lmax</code>+1)</dt>
<dd>The degree correlation function, which is equal to <code>Sgt/sqrt(Sgg Stt)</code>.
</dd>
</dl>
<h1 id="parameters">Parameters</h1>
<dl>
<dt><code>gilm</code> : float, dimension (2, <code>lmaxg</code>+1, <code>lmaxg</code>+1)</dt>
<dd>The real spherical harmonic coefficients of the function <code>G</code>.
</dd>
<dt><code>tilm</code> : float, dimension (2, <code>lmaxt</code>+1, <code>lmaxt</code>+1)</dt>
<dd>The real spherical harmonic coefficients of the function <code>T</code>.
</dd>
<dt><code>lmax</code> : optional, integer, default = min(<code>lmaxg</code>, <code>lmaxt</code>)</dt>
<dd>The maximum spherical harmonic degree that will be calculated for the admittance and correlation spectra. This must be less than or equal to the minimum of <code>lmaxg</code> and <code>lmaxt</code>.
</dd>
</dl>
<h1 id="description">Description</h1>
<p><code>SHAdmitCorr</code> will calculate the admittance, admittance error, and correlation spectra associated with two real functions expressed in real spherical harmonics. The admittance is defined as <code>Sgt/Stt</code>, where <code>Sgt</code> is the cross-power spectrum of two functions <code>G</code> and <code>T</code>. The degree-correlation spectrum is defined as <code>Sgt/sqrt(Sgg Stt)</code>, which can possess values between -1 and 1. The error of the admittance is calculated assuming that <code>G</code> and <code>T</code> are related by a linear isotropic transfer function:<code>Gilm = Ql Tilm + Nilm</code>, where <code>N</code> is noise that is uncorrelated with the topography. It is important to note that the relationship between two fields is often not described by such an isotropic expression.</p>
<h1 id="see-also">See also</h1>
<p><a href="pyshpowerspectrum.html">shpowerspectrum</a>, <a href="pyshcrosspowerspectrum.html">shcrosspowerspectrum</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>