Skip to content

Commit efeeada

Browse files
authored
Merge pull request #220 from ElisR/209-document-low-precision
Add low precision warning to docstring of inverse Wigner function
2 parents f64b799 + 0c5e664 commit efeeada

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

s2fft/transforms/wigner.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ def inverse(
4040
4141
L (int): Harmonic band-limit.
4242
43-
N (int): Azimuthal band-limit.
43+
N (int): Azimuthal band-limit. For high precision beyond :math:`N \approx 8`,
44+
one should use `method="jax_ssht"`.
4445
4546
nside (int, optional): HEALPix Nside resolution parameter. Only required
4647
if sampling="healpix". Defaults to None.
@@ -123,7 +124,8 @@ def inverse_numpy(
123124
124125
L (int): Harmonic band-limit.
125126
126-
N (int): Azimuthal band-limit.
127+
N (int): Azimuthal band-limit. Recursive transform will have lower precision
128+
beyond :math:`N \approx 8`.
127129
128130
nside (int, optional): HEALPix Nside resolution parameter. Only required
129131
if sampling="healpix". Defaults to None.
@@ -207,7 +209,8 @@ def inverse_jax(
207209
208210
L (int): Harmonic band-limit.
209211
210-
N (int): Azimuthal band-limit.
212+
N (int): Azimuthal band-limit. Recursive transform will have lower precision
213+
beyond :math:`N \approx 8`.
211214
212215
nside (int, optional): HEALPix Nside resolution parameter. Only required
213216
if sampling="healpix". Defaults to None.

0 commit comments

Comments
 (0)