/
pyshcrosspowerl.1
49 lines (49 loc) · 1.34 KB
/
pyshcrosspowerl.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 1.17.2
.\"
.TH "pyshcrosspowerl" "1" "2016\-08\-11" "Python" "SHTOOLS 3.4"
.hy
.SH SHCrossPowerL
.PP
Compute the cross\-power of two real functions for a single spherical
harmonic degree.
.SH Usage
.PP
\f[C]cpower\f[] = pyshtools.SHCrossPowerL (\f[C]cilm1\f[],
\f[C]cilm2\f[], \f[C]l\f[])
.SH Returns
.TP
.B \f[C]cpower\f[] : float
The cross power of the two functions for spherical harmonic degree
\f[C]l\f[].
.RS
.RE
.SH Parameters
.TP
.B \f[C]cilm1\f[] : float, dimension (2, \f[C]lmaxin1\f[]+1, \f[C]lmaxin1\f[]+1)
The spherical harmonic coefficients of the first function.
.RS
.RE
.TP
.B \f[C]cilm2\f[] : float, dimension (2, \f[C]lmaxin2\f[]+1, \f[C]lmaxin2\f[]+1)
The spherical harmonic coefficients of the second function.
.RS
.RE
.TP
.B \f[C]l\f[] : integer
The spherical harmonic degree.
This must be less than or equal to the minimum of \f[C]lmaxin1\f[] and
\f[C]lmaxin2\f[].
.RS
.RE
.SH Description
.PP
\f[C]SHCrossPowerL\f[] will calculate the cross\-power of two functions
for a single spherical harmonic degree \f[C]l\f[].
This is explicitly calculated as:
.PP
\f[C]cpower\ =\ Sum_{i=0}^1\ Sum_{m=0}^l\ cilm1[i,\ l,\ m]\ *\ cilm2[i,\ l,\ m]\f[].
.SH See also
.PP
shpowerl, shpowerdensityl, shcrosspowerdensityl, shpowerspectrum,
shpowerspectrumdensity, shcrosspowerspectrum,
shcrosspowerspectrumdensity, shadmitcorr