Module sleplet.functions.coefficients

Contains the abstract Coefficients class.

Classes

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

Abstract parent class to handle harmonic/Slepian coefficients on the sphere.

Subclasses

• Flm
• Fp

Class variables

var L : int

The spherical harmonic bandlimit.

var coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var extra_args : list[int] | None

Control the extra arguments for the given set of spherical coefficients. Only to be set by the sphere CLI.

var name : str

var noise : float | None

How much to noise the data.

var reality : bool

var region : Region | None

Whether to set a region or not, used in the Slepian case.

var smoothing : int | None

How much to smooth the topographic map of the Earth by.

var snr : float | None

var spin : int

var wavelet_coefficients : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

var wavelets : numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Methods

def convolve(self: Self, f_coefficient: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], g_coefficient: numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]], *, shannon: int | None = None) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Perform the sifting convolution of the two inputs.

Args

f_coefficient

Input harmonic/Slepian coefficients.

g_coefficient

Input harmonic/Slepian coefficients.

shannon

The Shannon number, only used in the Slepian case.

Returns

The sifting convolution of the two inputs.

def rotate(self: Self, alpha: float, beta: float, *, gamma: float = 0) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128]]

Rotates given flm on the sphere by alpha/beta/gamma.

Args

alpha

The third Euler angle, a $\alpha$ rotation about the z-axis.

beta

The second Euler angle, a $\beta$ rotation about the y-axis.

gamma

The first Euler angle, a $\gamma$ rotation about the z-axis.

Returns

The rotated spherical harmonic coefficients.

def translate(self: Self, alpha: float, beta: float, *, shannon: int | None = None) ‑> numpy.ndarray[typing.Any, numpy.dtype[numpy.complex128 | numpy.float64]]

Perform the translation of the coefficients, used in the sifting convolution.

Args

alpha

The point on the 2-sphere to translate to, i.e. the $\phi$ value.

beta

The point on the 2-sphere to translate to, i.e. the $\theta$ value.

shannon

The Shannon number, only used in the Slepian case.

Returns

The translated spherical harmonic coefficients.