-
Notifications
You must be signed in to change notification settings - Fork 106
/
pyshcilmtocindex.1
40 lines (40 loc) · 1.19 KB
/
pyshcilmtocindex.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
.\" Automatically generated by Pandoc 2.0.3
.\"
.TH "pyshcilmtocindex" "1" "2016\-12\-15" "Python" "SHTOOLS 4.1"
.hy
.SH SHCilmToCindex
.PP
Convert a three\-dimensional array of spherical harmonic coefficients to
a two\-dimensional indexed array.
.SH Usage
.PP
\f[C]cindex\f[] = SHCilmToCindex (\f[C]cilm\f[], [\f[C]lmax\f[]])
.SH Returns
.TP
.B \f[C]cindex\f[] : float, dimension (2, (\f[C]lmax\f[]+1)*(\f[C]lmax\f[]+2)/2)
The indexed output spherical harmonic coefficients.
.RS
.RE
.SH Parameters
.TP
.B \f[C]cilm\f[] : float, dimension (2, \f[C]lmaxin\f[]+1, \f[C]lmaxin\f[]+1)
The input spherical harmonic coefficients.
\f[C]cilm[0,:,:]\f[] and \f[C]cilm[1,:,:]\f[] correspond to either the
real and imaginary components, or cosine and sine coefficients,
respectively.
.RS
.RE
.TP
.B \f[C]lmax\f[] : optional, integer, default = \f[C]lmaxin\f[]
Maximum degree of input spherical harmonics to convert.
.RS
.RE
.SH Description
.PP
\f[C]SHCilmToCindex\f[] will convert a three\-dimensional array of
spherical harmonic coefficients to a two\-dimensional indexed array.
The degree \f[C]l\f[] and order \f[C]m\f[] corresponds to the index
\f[C]l*(l+1)/2+m\f[].
.SH See also
.PP
shcindextocilm, shcilmtovector, shvectortocilm