SHTOOLS --- Tools for working with spherical harmonics

> Home > Documentation > Python > Classes

SHWindow

Subclasses
SHWindowCap Class for windows concentrated within a spherical cap.
SHWindowMask Class for windows concentrated in an arbitrary domain.
Initialization
x = SHWindow.from_cap() Construct windows concentrated with a spherical cap.
x = SHWindow.from_mask() Construct windows concentrated with an arbitrary region.
Attributes
kind Either 'cap' or 'mask'.
coeffs Array of spherical harmonic coefficients of the rotated spherical cap localization windows.
eigenvalues Concentration factors of the localization windows.
orders The angular orders for each of the spherical cap localization windows.
weights Taper weights used with the multitaper spectral analyses. Defaut is None.
lmax Spherical harmonic bandwidth of the localization windows.
theta Angular radius of the spherical cap localization domain (default in degrees).
theta_degrees True (default) if theta is in degrees.
nwin Number of localization windows. Default is (lmax+1)**2
clat, clon Latitude and longitude of the center of the rotated spherical cap localization windows (default in degrees).
coord_degrees True (default) if clat and clon are in degrees.
Methods
get_coeffs() Return an array of the spherical harmonic coefficients for taper i, where i=0 is the best concentrated, optionally using a different normalization convention.
get_degrees() Return an array containing the spherical harmonic degrees of the localization windows, from 0 to lmax.
get_powerperdegree() Return the power per degree spectra for one or more of the localization windows.
get_k() Return the number of localization windows that have concentration factors greater or equal to a specified value.
get_couplingmatrix() Return the coupling matrix of the first nwin tapers.
get_biasedpowerspectrum() Calculate the multitaper (cross-)power spectrum expectation of a localized function.
get_grid() Return as an array a grid of taper i, where i=0 is the best concentrated window.
get_multitaperpowerspectrum() Return the multitaper power spectrum estimate and uncertainty for the input SHCoeffs class instance.
get_multitapercrosspowerspectrum() Return the multitaper cross-power spectrum estimate and uncertainty for two input SHCoeffs class instances.
return_coeffs() Return the spherical harmonic coefficients of taper i, where i=0 is the best concentrated, as a new SHCoeffs class instance, optionally using a different normalization convention.
return_grid() Return as a new SHGrid instance a grid of taper i, where i=0 is the best concentrated window.
rotate() Rotate the spherical cap tapers, originally located at the north pole, to clat and clon and save the spherical harmonic coefficients in coeffs.
plot_windows() Plot the best concentrated localization windows using a simple cylindrical projection.
plot_powerperdegree() Plot the power spectra of the best concentrated localization windows.
plot_couplingmatrix() Plot the multitaper coupling matrix.
info() Print a summary of the data stored in the SHWindow instance.

> Home > Documentation > Python > Classes

Institut de Physique du Globe de Paris University of Sorbonne Paris Cité © 2016 SHTOOLS