From 0c5e66453735bb854c7aa7d64807848c34be6ed4 Mon Sep 17 00:00:00 2001 From: Elis Roberts Date: Thu, 26 Sep 2024 08:09:23 +0100 Subject: [PATCH] docs: Add low precision warning to inverse Wigner docstring --- s2fft/transforms/wigner.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/s2fft/transforms/wigner.py b/s2fft/transforms/wigner.py index 1fe213dc..5b140780 100644 --- a/s2fft/transforms/wigner.py +++ b/s2fft/transforms/wigner.py @@ -40,7 +40,8 @@ def inverse( L (int): Harmonic band-limit. - N (int): Azimuthal band-limit. + N (int): Azimuthal band-limit. For high precision beyond :math:`N \approx 8`, + one should use `method="jax_ssht"`. nside (int, optional): HEALPix Nside resolution parameter. Only required if sampling="healpix". Defaults to None. @@ -123,7 +124,8 @@ def inverse_numpy( L (int): Harmonic band-limit. - N (int): Azimuthal band-limit. + N (int): Azimuthal band-limit. Recursive transform will have lower precision + beyond :math:`N \approx 8`. nside (int, optional): HEALPix Nside resolution parameter. Only required if sampling="healpix". Defaults to None. @@ -207,7 +209,8 @@ def inverse_jax( L (int): Harmonic band-limit. - N (int): Azimuthal band-limit. + N (int): Azimuthal band-limit. Recursive transform will have lower precision + beyond :math:`N \approx 8`. nside (int, optional): HEALPix Nside resolution parameter. Only required if sampling="healpix". Defaults to None.