Skip to main content

Differentiable and accelerated spherical transforms with JAX

Project description

https://github.com/astro-informatics/s2fft/actions/workflows/tests.yml/badge.svg?branch=main https://img.shields.io/badge/GitHub-s2fft-brightgreen.svg?style=flat https://codecov.io/gh/astro-informatics/s2fft/branch/main/graph/badge.svg?token=7QYAFAAWLE https://img.shields.io/badge/License-MIT-yellow.svg http://img.shields.io/badge/arXiv-2311.14670-orange.svg?style=flat https://img.shields.io/badge/code%20style-black-000000.svg https://colab.research.google.com/assets/colab-badge.svg

Differentiable and accelerated spherical transforms with JAX

S2FFT is a JAX package for computing Fourier transforms on the sphere and rotation group. It leverages autodiff to provide differentiable transforms, which are also deployable on hardware accelerators (e.g. GPUs and TPUs).

More specifically, S2FFT provides support for spin spherical harmonic and Wigner transforms (for both real and complex signals), with support for adjoint transformations where needed, and comes with different optimisations (precompute or not) that one may select depending on available resources and desired angular resolution $L$.

Documentation

Read the full documentation here.

Attribution

Should this code be used in any way, we kindly request that the following article is referenced. A BibTeX entry for this reference may look like:

@article{price:s2fft,
    author      = "Matthew A. Price and Jason D. McEwen",
    title       = "Differentiable and accelerated spherical harmonic and Wigner transforms",
    journal     = "Journal of Computational Physics",
    year        = "2023",
    eprint      = "arXiv:2311.14670"
}

You might also like to consider citing our related papers on which this code builds:

@article{mcewen:fssht,
    author      = "Jason D. McEwen and Yves Wiaux",
    title       = "A novel sampling theorem on the sphere",
    journal     = "IEEE Trans. Sig. Proc.",
    year        = "2011",
    volume      = "59",
    number      = "12",
    pages       = "5876--5887",
    eprint      = "arXiv:1110.6298",
    doi         = "10.1109/TSP.2011.2166394"
}
@article{mcewen:so3,
    author      = "Jason D. McEwen and Martin B{\"u}ttner and Boris ~Leistedt and Hiranya V. Peiris and Yves Wiaux",
    title       = "A novel sampling theorem on the rotation group",
    journal     = "IEEE Sig. Proc. Let.",
    year        = "2015",
    volume      = "22",
    number      = "12",
    pages       = "2425--2429",
    eprint      = "arXiv:1508.03101",
    doi         = "10.1109/LSP.2015.2490676"
}

License

We provide this code under an MIT open-source licence with the hope that it will be of use to a wider community.

Copyright 2023 Matthew Price, Jason McEwen and contributors.

S2FFT is free software made available under the MIT License. For details see the LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

s2fft-1.0.0.tar.gz (7.6 MB view details)

Uploaded Source

Built Distribution

s2fft-1.0.0-py3-none-any.whl (84.3 kB view details)

Uploaded Python 3

File details

Details for the file s2fft-1.0.0.tar.gz.

File metadata

  • Download URL: s2fft-1.0.0.tar.gz
  • Upload date:
  • Size: 7.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.0

File hashes

Hashes for s2fft-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ad5dd8045e17383ec485ed5f67977a01fed8223517d10eee1b4ea52ba098711c
MD5 c356b786e1c591dcb40b0f9b4b0fc37f
BLAKE2b-256 fdfa3bb430247d5a80b0ccbbf192e44c4526d4f24e1e0c35a39ba89eaa84d057

See more details on using hashes here.

File details

Details for the file s2fft-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: s2fft-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 84.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.0

File hashes

Hashes for s2fft-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1102e14948dd12035b49503baeada33dee319a7a676122c6be3adc9d8c6a0722
MD5 08d6384259929f71e654f0d280b5fb2a
BLAKE2b-256 a415a28a2c7de21362f0ca75ba13d8277bdee4d60e90e2d90730b3e0a72e59d7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page