Skip to main content

Hankel Transformations using method of Ogata 2005

Project description

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 fall over 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.

Installation

Either clone the repository at github.com/steven-murray/hankel and use python setup.py install, or simply install using pip install hankel.

The only dependencies are numpy, scipy and mpmath (as of v0.2.0).

Usage

Setup

This implementation is set up to allow efficient calculation of multiple functions f(x). To do this, the format is class-based, with the main object taking as arguments the order of the Bessel function, and the number and size of the integration steps (see Limitations for discussion about how to choose these key parameters).

For any general integration or transform of a function, we perform the following setup:

from hankel import HankelTransform     # Import the basic class

ht = HankelTransform(nu= 0,            # The order of the bessel function
                     N = 120,          # Number of steps in the integration
                     h = 0.03)         # Proxy for "size" of steps in integration

Alternatively, each of the parameters has defaults, so you needn’t pass any. The order of the bessel function will be defined by the problem at hand, while the other arguments typically require some exploration to set them optimally.

Integration

A Hankel-type integral is the integral

docimages/integrate.svg

Having set up our transform with nu = 0, we may wish to perform this integral for f(x) = 1. To do this, we do the following:

f = lambda x : 1   # Create a function which identically 1.
ht.integrate(f)    # Should give (1.0000000000003544, -9.8381428368537518e-15)

The correct answer is 1, so we have done quite well. The second element of the returned result is an estimate of the error (it is the last term in the summation). The error estimate can be omitted using the argument ret_err=False.

We may now wish to integrate a different function, say x/(x^2 + 1). We can do this directly with the same object, without re-instantiating (avoiding unnecessary recalculation):

f = lambda x : x/(x**2 + 1)
ht.integrate(f)               # Should give (0.42098875721567186, -2.6150757700135774e-17)

The analytic answer here is K_0(1) = 0.4210. The accuracy could be increased by creating ht with a higher number of steps N, and lower stepsize h (see Limitations).

Transforms

The Hankel transform is defined as

docimages/transform.svg

We see that the Hankel-type integral is the Hankel transform of f(r)/r with k=1. To perform this more general transform, we must supply the k values. Again, let’s use our previous function, x/(x^2 + 1):

import numpy as np              # Import numpy
k = np.logspace(-1,1,50)        # Create a log-spaced array of k from 0.1 to 10.
ht.transform(f,k,ret_err=False) # Return the transform of f at k.

Fourier Transforms

One of the most common applications of the Hankel transform is to solve the radially symmetric n-dimensional Fourier transform:

docimages/fourier.svg

We provide a specific class to do this transform, which takes into account the various normalisations and substitutions required, and also provides the inverse transform. The procedure is similar to the basic HankelTransform, but we provide the number of dimensions, rather than the Bessel order directly. Say we wish to find the Fourier transform of f(r) = 1/r in 3 dimensions:

from hankel import SymmetricFourierTransform
ft = SymmetricFourierTransform(ndim=3, N = 200, h = 0.03)

f = lambda r : 1./r
ft.transform(f,k, ret_err=False)

To do the inverse transformation (which is different by a normalisation constant), merely supply inverse=True to the .transform() method.

Limitations

Efficiency

An implementation-specific limitation is that the method is not perfectly efficient in all cases. Care has been taken to make it efficient in the general sense. However, for specific orders and functions, simplifications may be made which reduce the number of trigonometric functions evaluated. For instance, for a zeroth-order spherical transform, the weights are analytically always identically 1.

Lower-Bound Convergence

In terms of limitations of the method, they are very dependent on the form of the function chosen. Notably, functions which tend to infinity at x=0 will be poorly approximated in this method, and will be highly dependent on the step-size parameter, as the information at low-x will be lost between 0 and the first step. As an example consider the simple function f(x) = 1/sqrt(x) with a 1/2 order bessel function. The total integrand tends to 1 at x=0, rather than 0:

f = lambda x: 1/np.sqrt(x)
h = HankelTransform(0.5,120,0.03)
h.integrate(f)  #(1.2336282286725169, 9.1467916948046785e-17)

The true answer is sqrt(pi/2), which is a difference of about 1.6%. Modifying the step size and number of steps to gain accuracy we find:

h = HankelTransform(0.5,700,0.001)
h.integrate(f)   #(1.2523045156429067, -0.0012281146007910256)

This has much better than percent accuracy, but uses 5 times the amount of steps. The key here is the reduction of h to “get inside” the low-x information. This limitation is amplified for cases where the function really does tend to infinity at x=0, rather than a finite positive number, such as f(x) = 1/x. Clearly the integral becomes non-convergent for some f(x), in which case the numerical approximation can never be correct.

Upper-Bound Convergence

If the function f(x) is monotonically increasing, or at least very slowly decreasing, then higher and higher zeros of the Bessel function will be required to capture the convergence. Often, it will be the case that if this is so, the amplitude of the function is low at low x, so that the step-size h can be increased to facilitate this. Otherwise, the number of steps N can be increased.

For example, the 1/2-order integral supports functions that are increasing up to f(x) = x^0.5 and no more (otherwise they diverge). Let’s use f(x) = x^0.4 as an example of a slowly converging function, and use our “hi-res” setup from the previous section:

h = HankelTransform(0.5,700,0.001)
f = lambda x : x**0.4
h.integrate(f)   # (0.53678277933471386, -1.0590954621246349)

The analytic result is 0.8421449 – very far from our result. Note that in this case, the error estimate itself is a good indication that we haven’t reached convergence. We could try increasing N:

h = HankelTransform(0.5,10000,0.001)
h.integrate(f,ret_err=False)/0.8421449 -1     ## 7.128e-07

This is very accurate, but quite slow. Alternatively, we could try increasing h:

h = HankelTransform(0.5,700,0.03)
h.integrate(f,ret_err=False)/0.8421449 -1     ## 0.00045616

Not quite as accurate, but still far better than a percent for a hundredth of the cost!

There are some notebooks in the devel/ directory which toy with some known integrals, and show how accurate different choices of N and h are. They are interesting to view to see some of the patterns.

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.

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)

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-0.3.1.tar.gz (8.7 kB view details)

Uploaded Source

Built Distributions

hankel-0.3.1-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

hankel-0.3.1-py2-none-any.whl (15.1 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: hankel-0.3.1.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for hankel-0.3.1.tar.gz
Algorithm Hash digest
SHA256 be7f725833b6e1efefe23f492f4fa7cadde65503a718f28134ba1db3f75af5d3
MD5 494d7543962ac2e22658760dad7e21e8
BLAKE2b-256 cd1fc02d8f32109e6b922c36ff848f8c46846c10a53869cb157d5972f7a218e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hankel-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 118047610d70183d55b48860350b60456b1660f99b77fb587da0aeda702d6085
MD5 702db560be6f1bd89f9db8ed6588885b
BLAKE2b-256 3c3b1bd68db175a77c31bb4b9aff08cc7fd244fb01da9f905eff6f4321300ec8

See more details on using hashes here.

File details

Details for the file hankel-0.3.1-py2-none-any.whl.

File metadata

File hashes

Hashes for hankel-0.3.1-py2-none-any.whl
Algorithm Hash digest
SHA256 5c8b6251459a9dd5093e22e6e771527f808c72fe09d6cf50e277c1d7470676f4
MD5 eabdb68c161b79bbcc8b09ea058f3915
BLAKE2b-256 5b4c97adb2a6039dc4194f9812c5365fc1e7e176224b79e5a34f3a0d8b53958e

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