/
pyshrtoc.1
61 lines (61 loc) · 2.01 KB
/
pyshrtoc.1
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
.\" Automatically generated by Pandoc 1.17.2
.\"
.TH "pyshrtoc" "1" "2016\-08\-11" "Python" "SHTOOLS 3.4"
.hy
.SH SHrtoc
.PP
Convert real spherical harmonics to complex form.
.SH Usage
.PP
\f[C]ccilm\f[] = pyshtools.SHrtoc (\f[C]rcilm\f[], [\f[C]lmax\f[],
\f[C]convention\f[], \f[C]switchcs\f[]])
.SH Returns
.TP
.B \f[C]ccilm\f[] : float, dimension (2, \f[C]lmax\f[]+1, \f[C]lmax\f[]+1)
The output complex spherical harmonic coefficients.
\f[C]ccilm[0,:,:]\f[] and \f[C]ccilm[1,:,:]\f[] 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 \f[C]C_{l\-m}=(\-1)^m\ C_{lm}^*\f[].
.RS
.RE
.SH Parameters
.TP
.B \f[C]rcilm\f[] : float, dimension (2, \f[C]lmaxin\f[]+1, \f[C]lmaxin\f[]+1)
The input real spherical harmonic coefficients.
\f[C]rcilm[0,:,:]\f[] and \f[C]rcilm[1,:,:]\f[] correspond to the cosine
and sine terms, respectively.
.RS
.RE
.TP
.B \f[C]lmax\f[] : optional, integer, default = \f[C]lmaxin\f[]
The maximum degree of the output coefficients.
.RS
.RE
.TP
.B \f[C]convention\f[] : optional, integer, default = 1
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.
.RS
.RE
.TP
.B \f[C]swtichcs\f[] : optional, integer default = 0
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.
.RS
.RE
.SH Description
.PP
\f[C]SHrtoc\f[] will convert real spherical harmonics to complex form.
The normalization of the input and output coefficients are by default
the same, but if the optional argument \f[C]convention\f[] 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 \f[C]switchcs\f[].
.SH See also
.PP
shctor