__init__.py 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. """
  2. ==============================================
  3. Discrete Fourier transforms (:mod:`scipy.fft`)
  4. ==============================================
  5. .. currentmodule:: scipy.fft
  6. Fast Fourier Transforms (FFTs)
  7. ==============================
  8. .. autosummary::
  9. :toctree: generated/
  10. fft - Fast (discrete) Fourier Transform (FFT)
  11. ifft - Inverse FFT
  12. fft2 - 2-D FFT
  13. ifft2 - 2-D inverse FFT
  14. fftn - N-D FFT
  15. ifftn - N-D inverse FFT
  16. rfft - FFT of strictly real-valued sequence
  17. irfft - Inverse of rfft
  18. rfft2 - 2-D FFT of real sequence
  19. irfft2 - Inverse of rfft2
  20. rfftn - N-D FFT of real sequence
  21. irfftn - Inverse of rfftn
  22. hfft - FFT of a Hermitian sequence (real spectrum)
  23. ihfft - Inverse of hfft
  24. hfft2 - 2-D FFT of a Hermitian sequence
  25. ihfft2 - Inverse of hfft2
  26. hfftn - N-D FFT of a Hermitian sequence
  27. ihfftn - Inverse of hfftn
  28. Discrete Sin and Cosine Transforms (DST and DCT)
  29. ================================================
  30. .. autosummary::
  31. :toctree: generated/
  32. dct - Discrete cosine transform
  33. idct - Inverse discrete cosine transform
  34. dctn - N-D Discrete cosine transform
  35. idctn - N-D Inverse discrete cosine transform
  36. dst - Discrete sine transform
  37. idst - Inverse discrete sine transform
  38. dstn - N-D Discrete sine transform
  39. idstn - N-D Inverse discrete sine transform
  40. Fast Hankel Transforms
  41. ======================
  42. .. autosummary::
  43. :toctree: generated/
  44. fht - Fast Hankel transform
  45. ifht - Inverse of fht
  46. Helper functions
  47. ================
  48. .. autosummary::
  49. :toctree: generated/
  50. fftshift - Shift the zero-frequency component to the center of the spectrum
  51. ifftshift - The inverse of `fftshift`
  52. fftfreq - Return the Discrete Fourier Transform sample frequencies
  53. rfftfreq - DFT sample frequencies (for usage with rfft, irfft)
  54. fhtoffset - Compute an optimal offset for the Fast Hankel Transform
  55. next_fast_len - Find the optimal length to zero-pad an FFT for speed
  56. set_workers - Context manager to set default number of workers
  57. get_workers - Get the current default number of workers
  58. Backend control
  59. ===============
  60. .. autosummary::
  61. :toctree: generated/
  62. set_backend - Context manager to set the backend within a fixed scope
  63. skip_backend - Context manager to skip a backend within a fixed scope
  64. set_global_backend - Sets the global fft backend
  65. register_backend - Register a backend for permanent use
  66. """
  67. from ._basic import (
  68. fft, ifft, fft2, ifft2, fftn, ifftn,
  69. rfft, irfft, rfft2, irfft2, rfftn, irfftn,
  70. hfft, ihfft, hfft2, ihfft2, hfftn, ihfftn)
  71. from ._realtransforms import dct, idct, dst, idst, dctn, idctn, dstn, idstn
  72. from ._fftlog import fhtoffset
  73. from ._fftlog_multimethods import fht, ifht
  74. from ._helper import next_fast_len
  75. from ._backend import (set_backend, skip_backend, set_global_backend,
  76. register_backend)
  77. from numpy.fft import fftfreq, rfftfreq, fftshift, ifftshift
  78. from ._pocketfft.helper import set_workers, get_workers
  79. __all__ = [
  80. 'fft', 'ifft', 'fft2', 'ifft2', 'fftn', 'ifftn',
  81. 'rfft', 'irfft', 'rfft2', 'irfft2', 'rfftn', 'irfftn',
  82. 'hfft', 'ihfft', 'hfft2', 'ihfft2', 'hfftn', 'ihfftn',
  83. 'fftfreq', 'rfftfreq', 'fftshift', 'ifftshift',
  84. 'next_fast_len',
  85. 'dct', 'idct', 'dst', 'idst', 'dctn', 'idctn', 'dstn', 'idstn',
  86. 'fht', 'ifht',
  87. 'fhtoffset',
  88. 'set_backend', 'skip_backend', 'set_global_backend', 'register_backend',
  89. 'get_workers', 'set_workers']
  90. from scipy._lib._testutils import PytestTester
  91. test = PytestTester(__name__)
  92. del PytestTester