Skip to main content
`Ctrl`+`K`
scipy.signal.windows.

# tukey

scipy.signal.windows.tukey(M, alpha=0.5, sym=True, *, xp=None, device=None)

  Return a Tukey window, also known as a tapered cosine window.

  Parameters:
    M int

      Number of points in the output window. If zero, an empty array is returned. An exception is thrown when it is negative.

    alpha float, optional

      Shape parameter of the Tukey window, representing the fraction of the window inside the cosine tapered region. If zero, the Tukey window is equivalent to a rectangular window. If one, the Tukey window is equivalent to a Hann window.

    sym bool, optional

      When True (default), generates a symmetric window, for use in filter design. When False, generates a periodic window, for use in spectral analysis.

    xp array_namespace, optional

      Optional array namespace. Should be compatible with the array API standard, or supported by array-api-compat. Default: `numpy`

    device any

      optional device specification for output. Should match one of the supported device specification in `xp`.

  Returns:
    w ndarray

      The window, with the maximum value normalized to 1 (though the value 1 does not appear if M is even and sym is True).

  Notes

  Array API Standard Support

  `tukey` has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable `SCIPY_ARRAY_API=1` and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported.

  Library | CPU | GPU
  --- | --- | ---
  NumPy | ✅ | n/a
  CuPy | n/a | ✅
  PyTorch | ✅ | ✅
  JAX | ✅ | ✅
  Dask | ✅ | n/a

  See Support for the array API standard for more information.

  References

  [1]

  Harris, Fredric J. (Jan 1978). “On the use of Windows for Harmonic Analysis with the Discrete Fourier Transform”. Proceedings of the IEEE 66 (1): 51-83. DOI:10.1109/PROC.1978.10837

  [2]

  Wikipedia, “Window function”, https://en.wikipedia.org/wiki/Window_function#Tukey_window

  Examples

  Plot the window and its frequency response:

      >>> import numpy as np
      >>> from scipy import signal
      >>> from scipy.fft import fft, fftshift
      >>> import matplotlib.pyplot as plt

      >>> window = signal.windows.tukey(51)
      >>> plt.plot(window)
      >>> plt.title("Tukey window")
      >>> plt.ylabel("Amplitude")
      >>> plt.xlabel("Sample")
      >>> plt.ylim([0, 1.1])

      >>> plt.figure()
      >>> A = fft(window, 2048) / (len(window)/2.0)
      >>> freq = np.linspace(-0.5, 0.5, len(A))
      >>> response = 20 * np.log10(np.abs(fftshift(A / abs(A).max())))
      >>> plt.plot(freq, response)
      >>> plt.axis([-0.5, 0.5, -120, 0])
      >>> plt.title("Frequency response of the Tukey window")
      >>> plt.ylabel("Normalized magnitude [dB]")
      >>> plt.xlabel("Normalized frequency [cycles per sample]")