/
__init__.py
139 lines (128 loc) · 6.82 KB
/
__init__.py
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
"""
pyshtools Global and Localized Spectral Analysis Routines.
This subpackage of pyshtools defines the following functions:
Global spectral analysis
------------------------
spectrum Calculate the spectrum of a real or complex function.
cross_spectrum Calculate the cross-spectrum of two real or complex
functions.
SHAdmitCorr Calculate the admittance and correlation spectra
of two functions.
SHConfidence Compute the probability that two sets of
spherical harmonic coefficients are correlated at
a given degree and for a given correlation coefficient.
Multitaper spectral estimation (spherical cap domain)
-----------------------------------------------------
SHMultiTaperSE Perform a localized multitaper spectral analysis.
SHMultiTaperCSE Perform a localized multitaper cross-spectral analysis.
SHLocalizedAdmitCorr Calculate the localized admittance and correlation
spectra of two functions at a given location.
SHReturnTapers Calculate the eigenfunctions of the spherical-cap
concentration problem.
SHReturnTapersM Calculate the eigenfunctions of the spherical-cap
concentration problem for a single angular order.
ComputeDm Compute the space-concentration kernel of a spherical
cap.
ComputeDG82 Compute the tridiagonal matrix of Grunbaum et al. (1982)
that commutes with the space-concentration kernel of a
spherical cap.
SHFindLWin Determine the spherical-harmonic bandwidth that is
necessary to achieve a certain concentration factor.
SHBiasK Calculate the multitaper (cross-)power spectrum
expectation of a windowed function.
SHMTCouplingMatrix Compute the multitaper coupling matrix for a given set
of localization windows.
SHBiasAdmitCorr Calculate the expected multitaper admittance and
correlation spectra associated with the input global
cross-power spectra of two functions.
SHMTDebias Invert for the global power spectrum given a localized
multitaper spectrum estimate.
SHMTVarOpt Calculate the minimum variance and corresponding optimal
weights of a localized multitaper spectral estimate.
SHMTVar Calculate the theoretical variance of a multitaper
spectral estimate for a given input power spectrum.
SHSjkPG Calculate the expectation of the product of two
functions, each multiplied by a different data taper,
for a given spherical harmonic degree and two different
angular orders.
SHRotateTapers Rotate the spherical cap tapers by three Euler angles.
Localization windows (arbitrary domain)
---------------------------------------
SHReturnTapersMap Calculate the eigenfunctions of the concentration
problem for an arbitrary concentration region.
SHMultiTaperMaskSE Perform a localized multitaper spectral analysis using
arbitrary windows.
SHMultiTaperMaskCSE Perform a localized multitaper cross-spectral analysis
using arbitrary windows.
SHBiasKMask Calculate the multitaper (cross-)power spectrum
expectation of a function localized by arbitrary
windows derived from a mask.
ComputeDMap Compute the space-concentration kernel of a mask
defined on the sphere.
Curve2Mask Given a set of latitude and longitude coordinates
representing a closed curve, output a gridded mask.
Localization Bias (General)
---------------------------
SHBias Calculate the (cross-)power spectrum expectation of a
windowed function.
Slepian function expansions
---------------------------
SlepianCoeffs Determine the expansion coefficients of a function for
a given set of input Slepian functions.
SlepianCoeffsToSH Convert a function expressed in Slepian coefficients to
spherical harmonic coefficients.
SHSCouplingMatrix Compute the spherical harmonic coupling matrix for a
given set of Slepian functions.
SHSCouplingMatrixCap Compute the spherical harmonic coupling matrix for a
given set of spherical-cap Slepian functions.
SHSlepianVar Calculate the theoretical variance of the power of a
function expanded in spherical-cap Slepian functions.
Other
-----
SphericalCapCoef Calculate the spherical harmonic coefficients of a
spherical cap.
"""
from ..shtools import SHAdmitCorr
from ..shtools import SHConfidence
from .spectrum import spectrum
from .cross_spectrum import cross_spectrum
from ..shtools import SHMultiTaperSE
from ..shtools import SHMultiTaperCSE
from ..shtools import SHLocalizedAdmitCorr
from ..shtools import SHReturnTapers
from ..shtools import SHReturnTapersM
from ..shtools import ComputeDm
from ..shtools import ComputeDG82
from ..shtools import SHFindLWin
from ..shtools import SHBiasK
from ..shtools import SHMTCouplingMatrix
from ..shtools import SHBiasAdmitCorr
from ..shtools import SHMTDebias
from ..shtools import SHMTVarOpt
from ..shtools import SHMTVar
from ..shtools import SHSjkPG
from ..shtools import SHMultiTaperMaskSE
from ..shtools import SHMultiTaperMaskCSE
from ..shtools import SHReturnTapersMap
from ..shtools import SHBiasKMask
from ..shtools import ComputeDMap
from ..shtools import Curve2Mask
from ..shtools import SHBias
from ..shtools import SphericalCapCoef
from ..shtools import SHRotateTapers
from ..shtools import SlepianCoeffs
from ..shtools import SlepianCoeffsToSH
from ..shtools import SHSCouplingMatrix
from ..shtools import SHSlepianVar
from ..shtools import SHSCouplingMatrixCap
# ---- Define __all__ for use with: from pyshtools import * ----
__all__ = ['SHAdmitCorr', 'SHConfidence', 'spectrum', 'cross_spectrum',
'SHMultiTaperSE', 'SHMultiTaperCSE', 'SHLocalizedAdmitCorr',
'SHReturnTapers', 'SHReturnTapersM', 'ComputeDm', 'ComputeDG82',
'SHFindLWin', 'SHBiasK', 'SHMTCouplingMatrix', 'SHBiasAdmitCorr',
'SHMTDebias', 'SHMTVarOpt', 'SHMTVar', 'SHSjkPG',
'SHMultiTaperMaskSE', 'SHMultiTaperMaskCSE', 'SHReturnTapersMap',
'SHBiasKMask', 'ComputeDMap', 'Curve2Mask', 'SHBias',
'SphericalCapCoef', 'SHRotateTapers', 'SlepianCoeffs',
'SlepianCoeffsToSH', 'SHSCouplingMatrix', 'SHSlepianVar',
'SHSCouplingMatrixCap']