Skip to main content

Hankel Transformations using method of Ogata 2005

Project description

https://github.com/steven-murray/hankel/actions/workflows/test_suite.yaml/badge.svg https://codecov.io/gh/steven-murray/hankel/branch/master/graph/badge.svg?token=GQY2Glwr0U http://joss.theoj.org/papers/10.21105/joss.01397/status.svg https://img.shields.io/pypi/v/hankel.svg https://img.shields.io/badge/code%20style-black-000000.svg

Perform simple and accurate Hankel transformations using the method of Ogata 2005.

Hankel transforms and integrals are commonplace in any area in which Fourier Transforms are required over fields that are radially symmetric (see Wikipedia for a thorough description). They involve integrating an arbitrary function multiplied by a Bessel function of arbitrary order (of the first kind). Typical integration schemes often fail because of the highly oscillatory nature of the transform. Ogata’s quadrature method used in this package provides a fast and accurate way of performing the integration based on locating the zeros of the Bessel function.

Features

  • Accurate and fast solutions to many Hankel integrals

  • Easy to use and re-use

  • Arbitrary order transforms

  • Built-in support for radially symmetric Fourier Transforms

  • Thoroughly tested.

  • only Python 3 compatible.

Installation

Either clone the repository and install locally (best for developer installs):

$ git clone https://github.com/steven-murray/hankel.git
$ cd hankel/
$ pip install -U .

Or install from PyPI:

$ pip install hankel

Or install with conda:

$ conda install -c conda-forge hankel

The only dependencies are numpy, scipy and mpmath. These will be installed automatically if they are not already installed.

Dependencies required purely for development (testing and linting etc.) can be installed via the optional extra pip install hankel[dev]. If using conda, they can still be installed via pip: pip install -r requirements_dev.txt.

For instructions on testing hankel or any other development- or contribution-related issues, see the contributing guide.

Acknowledging

If you find hankel useful in your research, please cite

S. G. Murray and F. J. Poulin, “hankel: A Python library for performing simple and accurate Hankel transformations”, Journal of Open Source Software, 4(37), 1397, https://doi.org/10.21105/joss.01397

Also consider starring this repository!

References

Based on the algorithm provided in

H. Ogata, A Numerical Integration Formula Based on the Bessel Functions, Publications of the Research Institute for Mathematical Sciences, vol. 41, no. 4, pp. 949-970, 2005. DOI: 10.2977/prims/1145474602

Also draws inspiration from

Fast Edge-corrected Measurement of the Two-Point Correlation Function and the Power Spectrum Szapudi, Istvan; Pan, Jun; Prunet, Simon; Budavari, Tamas (2005) The Astrophysical Journal vol. 631 (1) DOI: 10.1086/496971

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

hankel-1.2.2.tar.gz (6.5 MB view details)

Uploaded Source

Built Distribution

hankel-1.2.2-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file hankel-1.2.2.tar.gz.

File metadata

  • Download URL: hankel-1.2.2.tar.gz
  • Upload date:
  • Size: 6.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for hankel-1.2.2.tar.gz
Algorithm Hash digest
SHA256 ce1d1cd1f5a621a23c5fb49d66d67c10659e844b0c4191dbfdd0de6515766045
MD5 728299e228d6a858e2863bc40dcc26a4
BLAKE2b-256 c81e499e211d69eeb165677ecaf853daae7d38d0a29b0ce0c274e5d664516d7f

See more details on using hashes here.

File details

Details for the file hankel-1.2.2-py3-none-any.whl.

File metadata

  • Download URL: hankel-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for hankel-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9f4d40e0f4ce01f1013288edeba542ac455bf07bf40a79ec6278b980bdc3efb2
MD5 8163d95cc45f2978a443768b2f1ce5dc
BLAKE2b-256 07a781c1fd58eb86c34c3c9613414f98080f8b5aaf575c7d7b463e59635e0631

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