s2fft is currently in an open beta, please provide feedback on GitHub

Sampling Functions#

Array shaping functions#

Function Name

Description

f_shape()

Shape of a signal on the sphere and rotation group.

flm_shape()

Standard shape of harmonic coefficients.

flmn_shape()

Standard shape of Wigner coefficients.

ftm_shape()

Shape of intermediate array, before/after latitudinal step.

fnab_shape()

Shape of intermediate array, before/after latitudinal step.

Spherical sampling functions#

Function Name

Description

ncoeff()

Number of spherical harmonic coefficients for given band-limit L.

ntheta()

Total number of latitudinal samples.

ntheta_extension()

Total number of latitudinal samples for periodically extended sampling.

thetas()

Compute \(\theta\) samples for given sampling scheme.

t2theta()

Convert index to \(\theta\) angle for sampling scheme.

nphi_equiang()

Total number of longitudinal samples for equiangular sampling schemes.

nphi_equitorial_band()

Number of \(\phi\) samples within the equitorial band for HEALPix sampling scheme.

nphi_ring()

Number of \(\phi\) samples for HEALPix sampling on given \(\theta\) ring.

phis_ring()

Compute \(\phi\) samples for given \(\theta\) HEALPix ring.

p2phi_ring()

Convert index to \(\phi\) angle for HEALPix for given \(\theta\) ring.

phis_equiang()

Compute \(\phi\) samples for equiangular sampling scheme.

ring_phase_shift_hp()

Generates a phase shift vector for HEALPix for a given \(\theta\) ring.

Pixel indexing functions#

Function Name

Description

elm2ind()

Convert from spherical harmonic 2D indexing of \((\ell,m)\) to 1D index.

ind2elm()

Convert from 1D spherical harmonic index to 2D index of \((\ell,m)\).

elmn2ind()

Convert from Wigner 3D indexing of \((\ell,m)\) to 1D index.

hp_ang2pix()

Convert angles to HEALPix index for HEALPix ring ordering scheme.

hp_getidx()

Compute HEALPix harmonic index.

lm2lm_hp()

Converts from 1D indexed harmonic coefficients to HEALPix (healpy) indexed coefficients.

Sampling & dimensionality conversions#

Function Name

Description

flm_2d_to_1d()

Convert from 2D indexed harmonic coefficients to 1D indexed coefficients.

flm_1d_to_2d()

Convert from 1D indexed harmnonic coefficients to 2D indexed coefficients.

flm_hp_to_2d()

Converts from HEALPix (healpy) indexed harmonic coefficients to 2D indexed coefficients.

flm_2d_to_hp()

Converts from 2D indexed harmonic coefficients to HEALPix (healpy) indexed coefficients.

flmn_3d_to_1d()

Convert from 3D indexed Wigner coefficients to 1D indexed coefficients.

flmn_1d_to_3d()

Convert from 1D indexed Wigner coefficients to 3D indexed coefficients.