Top-level wrappers

s2ball.construct.matrix.generate_matrices(transform: str, L: int, N: int | None = None, P: int | None = None, spin: int = 0, tau: float = 1.0, lam_l: float = 2.0, lam_p: float = 2.0, save_dir: str = '.matrices')

Top level wrapper function which handles all precompute matrices.

Parameters:

• transform (str) – Name of transform to compute/laod matrices for. Choice from [“spherical_harmonic, wigner, spherical_laguerre, wigner_laguerre, wavelet”].

• L (int) – Harmonic band-limit.

• N (int, optional) – Azimuthal band-limit. Defaults to None.

• P (int, optional) – Radial band-limit. Defaults to None.

• spin (int, optional) – Spin number of field. Defaults to 0.

• tau (float, optional) – Laguerre polynomial scale factor. Defaults to 1.0.

• lam_l (float, optional) – Wavelet angular scaling factor. \(\lambda = 2.0\) indicates dyadic wavelets. Defaults to 2.0.

• lam_p (float, optional) – Wavelet radial scaling factor. \(\lambda = 2.0\) indicates dyadic wavelets. Defaults to 2.0.

• save_dir (str, optional) – Directory in which to save precomputed matrices. Defaults to “.matrices”.

Notes

We enforce the following ordering convention: where appropriate order by - Legendre - Laguerre - Wigner - Wavelet Filer with each entry having forward/inverse as first and second element resp.

Returns:

Collection of np.ndarrays which contain computed matrice elements.

Return type:

List[np.ndarray]