/
shrtoc.html
78 lines (67 loc) · 4.55 KB
/
shrtoc.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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>SHTOOLS - Spherical harmonic I/O and storage routines</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="../../../index.html">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="../../f95-routines.html" class="dir">Fortran 95</a> > <a href="../../io.html" class="dir">Spherical Harmonic I/O and Storage</a></p>
<h1 id="shrtoc">SHrtoc</h1>
<p>Convert real spherical harmonics to complex form.</p>
<h1 id="usage">Usage</h1>
<p>call SHrtoc (<code>rcilm</code>, <code>ccilm</code>, <code>degmax</code>, <code>convention</code>, <code>switchcs</code>, <code>exitstatus</code>)</p>
<h1 id="parameters">Parameters</h1>
<dl>
<dt><code>rcilm</code> : input, real*8, dimension (2, <code>lmaxin</code>+1, <code>lmaxin</code>+1)</dt>
<dd>The input real spherical harmonic coefficients. <code>rcilm(1,:,:)</code> and <code>rcilm(2,:,:)</code> correspond to the cosine and sine terms, respectively.
</dd>
<dt><code>ccilm</code> : output, real*8, dimension (2, <code>lmaxout</code>+1, <code>lmaxout</code>+1)</dt>
<dd>The output complex spherical harmonic coefficients. <code>ccilm(1,:,:)</code> and <code>ccilm(2,:,:)</code> correspond to the real and complex part of the coefficients, respectively. Only the positive angular orders are output; the negative orders can be calculated from the relation <code>C_{l-m}=(-1)^m C_{lm}^*</code>.
</dd>
<dt><code>degmax</code> : input, optional, integer, default = min(<code>lmaxin</code>, <code>lmaxout</code>)</dt>
<dd>The maximum degree of the output coefficients.
</dd>
<dt><code>convention</code> : input, optional, integer, default = 1</dt>
<dd>If 1 (default), the input and output coefficients will have the same normalization. If 2, real geodesy 4-pi coefficients will be converted to complex orthonormal form.
</dd>
<dt><code>swtichcs</code> : input, optional, integer, default = 0</dt>
<dd>If 0 (default), the input and output coefficients will possess the same Condon-Shortley phase convention. If 1, the input coefficients will first be multiplied by (-1)^m.
</dd>
<dt><code>exitstatus</code> : output, optional, integer</dt>
<dd>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.
</dd>
</dl>
<h1 id="description">Description</h1>
<p><code>SHrtoc</code> will convert real spherical harmonics to complex form. By default, the dimension of the output array is the minimum of <code>rcilm</code> and <code>ccilm</code>, though this can be changed by specifying the optional parameter <code>degmax</code>. The normalization of the input and output coefficients are by default the same, but if the optional argument <code>convention</code> is set to 2, this routine will convert from geodesy 4-pi normalized coefficients to orthonormalized coefficients. The Condon-Shortley phase convention between the input an output coefficients can be modified by the optional argument <code>switchs</code>.</p>
<h1 id="see-also">See also</h1>
<p><a href="shctor.html">shctor</a></p>
<p class="dir">
> <a href="../../../index.html" class="dir">Home</a> > <a href="../../documentation.html" class="dir">Documentation</a> > <a href="../../f95-routines.html" class="dir">Fortran 95</a> > <a href="../../io.html" class="dir">Spherical Harmonic I/O</a></p>
<table class="footer2">
<tbody>
<tr>
<td class="c1"><a href="https://lagrange.oca.eu/?lang=en">Laboratoire Lagrange</a></td>
<td class="c2"><a href="https://www.oca.eu/?lang=en">Observatoire de la Côte d'Azur</a></td>
<td class="c3">© 2017 <a href="https://github.com/SHTOOLS">SHTOOLS</a></td>
</tr>
</tbody>
</table>
</div>
</body>
</html>