{ } Raw JSON

bundles / scipy latest / scipy / fft / _fftlog_backend / fhtoffset

function

scipy.fft._fftlog_backend:fhtoffset

source: /scipy/fft/_fftlog_backend.py :121

Signature

def   fhtoffset ( dln mu initial = 0.0 bias = 0.0 )

Summary

Return optimal offset for a fast Hankel transform.

Extended Summary

Returns an offset close to initial that fulfils the low-ringing condition of [1] for the fast Hankel transform fht with logarithmic spacing dln, order mu and bias bias.

Parameters

dln : float

Uniform logarithmic spacing of the transform.

mu : float

Order of the Hankel transform, any positive or negative real number.

initial : float, optional

Initial value for the offset. Returns the closest value that fulfils the low-ringing condition.

bias : float, optional

Exponent of power law bias, any positive or negative real number.

Returns

offset : float

Optimal offset of the uniform logarithmic spacing of the transform that fulfils a low-ringing condition.

Notes

Array API Standard Support

fhtoffset is not in-scope for support of Python Array API Standard compatible backends other than NumPy.

See dev-arrayapi for more information.

Examples

from scipy.fft import fhtoffset
dln = 0.1
mu = 2.0
initial = 0.5
bias = 0.0
offset = fhtoffset(dln, mu, initial, bias)
offset

See also

fht

Definition of the fast Hankel transform.

Aliases

  • scipy.fft.fhtoffset