-
Notifications
You must be signed in to change notification settings - Fork 104
/
shrtoc.3
74 lines (74 loc) · 2.83 KB
/
shrtoc.3
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
.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "shrtoc" "1" "2021-02-15" "Fortran 95" "SHTOOLS 4.11"
.hy
.SH SHrtoc
.PP
Convert real spherical harmonics to complex form.
.SH Usage
.PP
call SHrtoc (\f[V]rcilm\f[R], \f[V]ccilm\f[R], \f[V]degmax\f[R],
\f[V]convention\f[R], \f[V]switchcs\f[R], \f[V]exitstatus\f[R])
.SH Parameters
.TP
\f[V]rcilm\f[R] : input, real(dp), dimension (2, \f[V]lmaxin\f[R]+1, \f[V]lmaxin\f[R]+1)
The input real spherical harmonic coefficients.
\f[V]rcilm(1,:,:)\f[R] and \f[V]rcilm(2,:,:)\f[R] correspond to the
cosine and sine terms, respectively.
.TP
\f[V]ccilm\f[R] : output, real(dp), dimension (2, \f[V]lmaxout\f[R]+1, \f[V]lmaxout\f[R]+1)
The output complex spherical harmonic coefficients.
\f[V]ccilm(1,:,:)\f[R] and \f[V]ccilm(2,:,:)\f[R] 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[V]C_{l-m}=(-1)\[ha]m C_{lm}\[ha]*\f[R].
.TP
\f[V]degmax\f[R] : input, optional, integer(int32), default = min(\f[V]lmaxin\f[R], \f[V]lmaxout\f[R])
The maximum degree of the output coefficients.
.TP
\f[V]convention\f[R] : input, optional, integer(int32), 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.
.TP
\f[V]swtichcs\f[R] : input, optional, integer(int32), 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)\[ha]m.
.TP
\f[V]exitstatus\f[R] : output, optional, integer(int32)
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.
.SH Description
.PP
\f[V]SHrtoc\f[R] will convert real spherical harmonics to complex form.
By default, the dimension of the output array is the minimum of
\f[V]rcilm\f[R] and \f[V]ccilm\f[R], though this can be changed by
specifying the optional parameter \f[V]degmax\f[R].
The normalization of the input and output coefficients are by default
the same, but if the optional argument \f[V]convention\f[R] 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[V]switchs\f[R].
.SH See also
.PP
shctor