cupyx.scipy.signal.ZoomFFT#

class cupyx.scipy.signal.ZoomFFT(n, fn, m=None, *, fs=2, endpoint=False)[source]#

Create a callable zoom FFT transform function.

This is a specialization of the chirp z-transform (CZT) for a set of equally-spaced frequencies around the unit circle, used to calculate a section of the FFT more efficiently than calculating the entire FFT and truncating. [1]

Parameters:

n (int) – The size of the signal.
fn (array_like) – A length-2 sequence [f1, f2] giving the frequency range, or a scalar, for which the range [0, fn] is assumed.
m (int, optional) – The number of points to evaluate. Default is n.
fs (float, optional) – The sampling frequency. If fs=10 represented 10 kHz, for example, then f1 and f2 would also be given in kHz. The default sampling frequency is 2, so f1 and f2 should be in the range [0, 1] to keep the transform below the Nyquist frequency.
endpoint (bool, optional) – If True, f2 is the last sample. Otherwise, it is not included. Default is False.

Returns:

f – Callable object f(x, axis=-1) for computing the zoom FFT on x.

Return type:

ZoomFFT

See also

zoom_fft: Convenience function for calculating a zoom FFT.

scipy.signal.ZoomFFT

Notes

The defaults are chosen such that f(x, 2) is equivalent to fft.fft(x) and, if m > len(x), that f(x, 2, m) is equivalent to fft.fft(x, m).

Sampling frequency is 1/dt, the time step between samples in the signal x. The unit circle corresponds to frequencies from 0 up to the sampling frequency. The default sampling frequency of 2 means that f1, f2 values up to the Nyquist frequency are in the range [0, 1). For f1, f2 values expressed in radians, a sampling frequency of 2*pi should be used.

Remember that a zoom FFT can only interpolate the points of the existing FFT. It cannot help to resolve two separate nearby frequencies. Frequency resolution can only be increased by increasing acquisition time.

These functions are implemented using Bluestein’s algorithm (as is scipy.fft). [2]

References

Methods

__call__(x, *, axis=-1)[source]#

Calculate the chirp z-transform of a signal.

Parameters:

x (array) – The signal to transform.
axis (int, optional) – Axis over which to compute the FFT. If not given, the last axis is used.

Returns:

out – An array of the same dimensions as x, but with the length of the transformed axis set to m.

Return type:

ndarray

points()[source]#: Return the points at which the chirp z-transform is computed.

__eq__(value, /)#: Return self==value.

__ne__(value, /)#: Return self!=value.

__lt__(value, /)#: Return self<value.

__le__(value, /)#: Return self<=value.

__gt__(value, /)#: Return self>value.

__ge__(value, /)#: Return self>=value.