/
shcrosspowerspectrum.1
48 lines (48 loc) · 1.91 KB
/
shcrosspowerspectrum.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
.\" Automatically generated by Pandoc 2.9.2
.\"
.TH "shcrosspowerspectrum" "1" "2019-09-23" "Fortran 95" "SHTOOLS 4.6"
.hy
.SH SHCrossPowerSpectrum
.PP
Compute the cross-power spectrum of two real functions.
.SH Usage
.PP
call SHCrossPowerSpectrum (\f[C]cilm1\f[R], \f[C]cilm2\f[R],
\f[C]lmax\f[R], \f[C]cspectrum\f[R], \f[C]exitstatus\f[R])
.SH Parameters
.TP
\f[B]\f[CB]cilm1\f[B]\f[R] : input, real(dp), dimension (2, \f[B]\f[CB]lmaxin1\f[B]\f[R]+1, \f[B]\f[CB]lmaxin1\f[B]\f[R]+1)
The first function expressed in real spherical harmonics.
.TP
\f[B]\f[CB]cilm2\f[B]\f[R] : input, real(dp), dimension (2, \f[B]\f[CB]lmaxin2\f[B]\f[R]+1, \f[B]\f[CB]lmaxin2\f[B]\f[R]+1)
The second function expressed in real spherical harmonics.
.TP
\f[B]\f[CB]lmax\f[B]\f[R] : input, integer
The maximum spherical harmonic degree to calculate the cross-power
spectrum.
This must be less than or equal to the minimum of \f[C]lmaxin1\f[R] and
\f[C]lmaxin2\f[R].
.TP
\f[B]\f[CB]cspectrum\f[B]\f[R] : output, real(dp), dimension (\f[B]\f[CB]lmax\f[B]\f[R]+1)
The cross-power spectrum of the two functions.
.TP
\f[B]\f[CB]exitstatus\f[B]\f[R] : 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.
.SH Description
.PP
\f[C]SHCrossPowerSpectrum\f[R] will calculate the cross-power spectrum
of two real functions expressed in real 4-pi normalized spherical
harmonics.
For a given degree spherical harmonic degree \f[C]l\f[R], this is
explicitly calculated as:
.PP
\f[C]cspectrum(l) = Sum_{i=1}\[ha]2 Sum_{m=0}\[ha]l cilm1(i, l+1, m+1) * cilm2(i, l+1, m+1)\f[R].
.SH See also
.PP
shpowerl, shpowerdensityl, shcrosspowerl, shcrosspowerdensityl,
shpowerspectrum, shpowerspectrumdensity, shcrosspowerspectrumdensity,
shadmitcorr