shcrosspowerspectrumdensityc.1

.\" Automatically generated by Pandoc 2.10
.\"
.TH "shcrosspowerspectrumdensityc" "1" "2020-04-07" "Fortran 95" "SHTOOLS 4.7"
.hy
.SH SHCrossPowerSpectrumDensityC
.PP
Compute the cross-power spectral density of two complex functions.
.SH Usage
.PP
call SHCrossPowerSpectrumDensityC (\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, complex(dp), dimension (2, \f[B]\f[CB]lmaxin1\f[B]\f[R]+1, \f[B]\f[CB]lmaxin1\f[B]\f[R]+1)
The complex spherical harmonics of the first complex function.
.TP
\f[B]\f[CB]cilm2\f[B]\f[R] : input, complex(dp), dimension (2, \f[B]\f[CB]lmaxin2\f[B]\f[R]+1, \f[B]\f[CB]lmaxin2\f[B]\f[R]+1)
The complex spherical harmonics of the first complex function.
.TP
\f[B]\f[CB]lmax\f[B]\f[R] : input, integer
The maximum spherical harmonic degree of the cross power spectral
density.
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, complex(dp), dimension (\f[B]\f[CB]lmax\f[B]\f[R]+1)
The cross-power spectral density of the two complex 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]SHCrossPowerSpectrumDensityC\f[R] will calculate the cross-power
spectral density of two complex functions expressed in complex 4-pi
normalized spherical harmonics.
For a given spherical harmonic degree \f[C]l\f[R], this is calculated
as:
.PP
\f[C]cspectrum(l) = Sum_{i=1}\[ha]2 Sum_{m=0}\[ha]l cilm1(i, l+1, m+1) * conjg[cilm2(i, l+1, m+1)] / (2l + 1)\f[R].
.SH See also
.PP
shpowerlc, shpowerdensitylc, shcrosspowerlc, shcrosspowerdensitylc,
shpowerspectrumc, shpowerspectrumdensityc, shcrosspowerspectrumc