Skip to main content

Hankel Transformations using method of Ogata 2005

Project description

https://travis-ci.org/steven-murray/hankel.svg?branch=master https://coveralls.io/repos/github/steven-murray/hankel/badge.svg?branch=master 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.0.0.tar.gz (6.5 MB view details)

Uploaded Source

Built Distribution

hankel-1.0.0-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hankel-1.0.0.tar.gz
  • Upload date:
  • Size: 6.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.0.0.post20200106 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.6

File hashes

Hashes for hankel-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a17e0db603e3bab4f7e2b4954c11a21a3fde50f8140dc878a28a5a1ef6cbb383
MD5 2a0010d73dab4cd366edd67e2070e51e
BLAKE2b-256 863763343d87d6c734f3f971ae9bb15fb9026ef9fdde17d1547871c1eca153fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hankel-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.0.0.post20200106 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.6

File hashes

Hashes for hankel-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 10e4d2321d2b747429ef8ef19385531b0ee011868cf25b21a967f057d02ba68a
MD5 897703d5324f4c72232d3a719223c352
BLAKE2b-256 e981d86f065a9ea10040db652edfa79405c7f095538a0e2d6d6587d010692ea8

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