Module sleplet.functions

Set of classes to create functions on the sphere.

Sub-modules

sleplet.functions.africa

Contains the Africa class.

sleplet.functions.axisymmetric_wavelet_coefficients_africa

Contains the AxisymmetricWaveletCoefficientsAfrica class.

sleplet.functions.axisymmetric_wavelet_coefficients_earth

Contains the AxisymmetricWaveletCoefficientsEarth class.

sleplet.functions.axisymmetric_wavelet_coefficients_south_america

Contains the AxisymmetricWaveletCoefficientsSouthAmerica class.

sleplet.functions.axisymmetric_wavelets

Contains the AxisymmetricWavelets class.

sleplet.functions.coefficients

Contains the abstract Coefficients class.

sleplet.functions.dirac_delta

Contains the DiracDelta class.

sleplet.functions.earth

Contains the Earth class.

sleplet.functions.elongated_gaussian

Contains the ElongatedGaussian class.

sleplet.functions.flm

Contains the abstract Flm class.

sleplet.functions.fp

Contains the abstract Fp class.

sleplet.functions.gaussian

Contains the Gaussian class.

sleplet.functions.harmonic_gaussian

Contains the HarmonicGaussian class.

sleplet.functions.identity

Contains the Identity class.

sleplet.functions.noise_earth

Contains the NoiseEarth class.

sleplet.functions.ridgelets

Contains the Ridgelets class.

sleplet.functions.slepian

Contains the Slepian class.

sleplet.functions.slepian_africa

Contains the SlepianAfrica class.

sleplet.functions.slepian_dirac_delta

Contains the SlepianDiracDelta class.

sleplet.functions.slepian_identity

Contains the SlepianIdentity class.

sleplet.functions.slepian_noise_africa

Contains the SlepianNoiseAfrica class.

sleplet.functions.slepian_noise_south_america

Contains the SlepianNoiseSouthAmerica class.

sleplet.functions.slepian_south_america

Contains the SlepianSouthAmerica class.

sleplet.functions.slepian_wavelet_coefficients_africa

Contains the SlepianWaveletCoefficientsAfrica class.

sleplet.functions.slepian_wavelet_coefficients_south_america

Contains the SlepianWaveletCoefficientsSouthAmerica class.

sleplet.functions.slepian_wavelets

Contains the SlepianWavelets class.

sleplet.functions.south_america

Contains the SouthAmerica class.

sleplet.functions.spherical_harmonic

Contains the SphericalHarmonic class.

sleplet.functions.squashed_gaussian

Contains the SquashedGaussian class.

sleplet.functions.wmap

Contains the Wmap class.

Classes

class Africa (*args: Any, **kwargs: Any)

Create a topographic map of the Earth setting everything outide of the Africa region to zero.

Ancestors

Inherited members

class AxisymmetricWaveletCoefficientsAfrica (*args: Any, **kwargs: Any)

Create axisymmetric wavelet coefficients of the Africa region.

Ancestors

Instance variables

var B : int

The type of the None singleton.

var j : int | None

The type of the None singleton.

var j_min : int

The type of the None singleton.

Inherited members

class AxisymmetricWaveletCoefficientsEarth (*args: Any, **kwargs: Any)

Create axisymmetric wavelet coefficients of the Earth.

Ancestors

Instance variables

var B : int

The type of the None singleton.

var j : int | None

The type of the None singleton.

var j_min : int

The type of the None singleton.

Inherited members

class AxisymmetricWaveletCoefficientsSouthAmerica (*args: Any, **kwargs: Any)

Create axisymmetric wavelet coefficients of the South America region.

Ancestors

Instance variables

var B : int

The type of the None singleton.

var j : int | None

The type of the None singleton.

var j_min : int

The type of the None singleton.

Inherited members

class AxisymmetricWavelets (*args: Any, **kwargs: Any)

Create scale-discretised axisymmetric wavelets. As seen in https://doi.org/10.1051/0004-6361/201220729.

Ancestors

Instance variables

var B : int

The type of the None singleton.

var j : int | None

The type of the None singleton.

var j_min : int

The type of the None singleton.

Inherited members

class DiracDelta (*args: Any, **kwargs: Any)

Create a Dirac delta.

Ancestors

Inherited members

class Earth (*args: Any, **kwargs: Any)

Create the topographic map of the Earth.

Ancestors

Inherited members

class ElongatedGaussian (*args: Any, **kwargs: Any)

Create an elongated Gaussian \exp(-(\frac{{(\theta-\overline{\theta})}^{2}}{2\sigma_{\theta}^{2}} + \frac{{(\phi-\overline{\phi})}^{2}}{2\sigma_{\phi}^{2}})).

Ancestors

Instance variables

var p_sigma : float

The type of the None singleton.

var t_sigma : float

The type of the None singleton.

Inherited members

class Gaussian (*args: Any, **kwargs: Any)

Create a Gaussian \exp(-\frac{{\ell}^{2}}{2\sigma^{2}}).

Ancestors

Instance variables

var sigma : float

The type of the None singleton.

Inherited members

class HarmonicGaussian (*args: Any, **kwargs: Any)

Create a harmonic Gaussian \exp(-(\frac{{\ell}^{2}}{2\sigma_{\ell}^{2}} + \frac{{m}^{2}}{2\sigma_{m}^{2}})).

Ancestors

Instance variables

var l_sigma : float

The type of the None singleton.

var m_sigma : float

The type of the None singleton.

Inherited members

class Identity (*args: Any, **kwargs: Any)

Create an identity function.

Ancestors

Inherited members

class NoiseEarth (*args: Any, **kwargs: Any)

Create a noised signal of the topographic map of the Earth.

Ancestors

Instance variables

var SNR : float

The type of the None singleton.

Inherited members

class Ridgelets (*args: Any, **kwargs: Any)

Crates scale-discretised wavelets. As seen in https://arxiv.org/abs/1510.01595.

Ancestors

Instance variables

var B : int

The type of the None singleton.

var j : int | None

The type of the None singleton.

var j_min : int

The type of the None singleton.

Inherited members

class Slepian (*args: Any, **kwargs: Any)

Create Slepian functions of the selected region.

Ancestors

Instance variables

var rank : int

The type of the None singleton.

Inherited members

class SlepianAfrica (*args: Any, **kwargs: Any)

Create a Slepian region on the topographic map of the Earth of the Africa region.

Ancestors

Inherited members

class SlepianDiracDelta (*args: Any, **kwargs: Any)

Create a Dirac delta of the Slepian coefficients.

Ancestors

Inherited members

class SlepianIdentity (*args: Any, **kwargs: Any)

Create an identify function in the Slepian region.

Ancestors

Inherited members

class SlepianNoiseAfrica (*args: Any, **kwargs: Any)

Create a noised Slepian region on the topographic map of the Earth of the Africa region.

Ancestors

Instance variables

var SNR : float

The type of the None singleton.

Inherited members

class SlepianNoiseSouthAmerica (*args: Any, **kwargs: Any)

Create a noised Slepian region on the topographic map of the Earth of the South America region.

Ancestors

Instance variables

var SNR : float

The type of the None singleton.

Inherited members

class SlepianSouthAmerica (*args: Any, **kwargs: Any)

Create a Slepian region on the topographic map of the Earth of the South America region.

Ancestors

Inherited members

class SlepianWaveletCoefficientsAfrica (*args: Any, **kwargs: Any)

Create Slepian wavelet coefficients of the Africa region.

Ancestors

Instance variables

var B : int

The type of the None singleton.

var j : int | None

The type of the None singleton.

var j_min : int

The type of the None singleton.

Inherited members

class SlepianWaveletCoefficientsSouthAmerica (*args: Any, **kwargs: Any)

Create Slepian wavelet coefficients of the South America region.

Ancestors

Instance variables

var B : int

The type of the None singleton.

var j : int | None

The type of the None singleton.

var j_min : int

The type of the None singleton.

Inherited members

class SlepianWavelets (*args: Any, **kwargs: Any)

Create the Slepian wavelets.

Ancestors

Instance variables

var B : int

The type of the None singleton.

var j : int | None

The type of the None singleton.

var j_min : int

The type of the None singleton.

Inherited members

class SouthAmerica (*args: Any, **kwargs: Any)

Create the South America region of the topographic map of the Earth.

Ancestors

Inherited members

class SphericalHarmonic (*args: Any, **kwargs: Any)

Create spherical harmonic functions.

Ancestors

Instance variables

var ell : int

The type of the None singleton.

var m : int

The type of the None singleton.

Inherited members

class SquashedGaussian (*args: Any, **kwargs: Any)

Create a squashed Gaussian \exp(-\frac{1}{2}{(\frac{\theta-\overline{\theta}}{\sigma_{\theta}})}^{2}) \sin{(\nu_{\phi}\phi)}.

Ancestors

Instance variables

var freq : float

The type of the None singleton.

var t_sigma : float

The type of the None singleton.

Inherited members

class Wmap (*args: Any, **kwargs: Any)

Create the WMAP data.

Ancestors

Inherited members