/
shpowerspectrumc.1
49 lines (49 loc) · 1.55 KB
/
shpowerspectrumc.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
.\" Automatically generated by Pandoc 2.0.3
.\"
.TH "shpowerspectrumc" "1" "2016\-12\-15" "Fortran 95" "SHTOOLS 4.1"
.hy
.SH SHPowerSpectrumC
.PP
Compute the power spectrum of a complex function.
.SH Usage
.PP
call SHPowerSpectrumC (\f[C]cilm\f[], \f[C]lmax\f[], \f[C]pspectrum\f[],
\f[C]exitstatus\f[])
.SH Parameters
.TP
.B \f[C]cilm\f[] : input, complex*16, dimension (2, \f[C]lmaxin\f[]+1, \f[C]lmaxin\f[]+1)
The complex function expressed in complex spherical harmonics.
.RS
.RE
.TP
.B \f[C]lmax\f[] : input, integer
The maximum spherical harmonic degree of the power spectrum.
This must be less than or equal to \f[C]lmaxin\f[].
.RS
.RE
.TP
.B \f[C]pspectrum\f[] : output, real*8, dimension (\f[C]lmax\f[]+1)
The power spectrum of the complex function.
.RS
.RE
.TP
.B \f[C]exitstatus\f[] : output, optional, integer
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.
.RS
.RE
.SH Description
.PP
\f[C]SHPowerSpectrumC\f[] will calculate the power spectrum of a complex
function expressed in complex 4\-pi normalized spherical harmonics.
For a given spherical harmonic degree \f[C]l\f[], this is calculated as:
.PP
\f[C]pspectrum(l)\ =\ Sum_{i=1}^2\ Sum_{m=0}^l\ |\ cilm(i,\ l+1,\ m+1)\ |**2\f[].
.SH See also
.PP
shpowerlc, shpowerdensitylc, shcrosspowerlc, shcrosspowerdensitylc,
shpowerspectrumdensityc, shcrosspowerspectrumc,
shcrosspowerspectrumdensityc