Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/scipy/fft/__init__.py: 100%

1""" 

2============================================== 

3Discrete Fourier transforms (:mod:`scipy.fft`) 

4============================================== 

5 

6.. currentmodule:: scipy.fft 

7 

8Fast Fourier Transforms (FFTs) 

9============================== 

10 

11.. autosummary:: 

12 :toctree: generated/ 

13 

14 fft - Fast (discrete) Fourier Transform (FFT) 

15 ifft - Inverse FFT 

16 fft2 - 2-D FFT 

17 ifft2 - 2-D inverse FFT 

18 fftn - N-D FFT 

19 ifftn - N-D inverse FFT 

20 rfft - FFT of strictly real-valued sequence 

21 irfft - Inverse of rfft 

22 rfft2 - 2-D FFT of real sequence 

23 irfft2 - Inverse of rfft2 

24 rfftn - N-D FFT of real sequence 

25 irfftn - Inverse of rfftn 

26 hfft - FFT of a Hermitian sequence (real spectrum) 

27 ihfft - Inverse of hfft 

28 hfft2 - 2-D FFT of a Hermitian sequence 

29 ihfft2 - Inverse of hfft2 

30 hfftn - N-D FFT of a Hermitian sequence 

31 ihfftn - Inverse of hfftn 

32 

33Discrete Sin and Cosine Transforms (DST and DCT) 

34================================================ 

35 

36.. autosummary:: 

37 :toctree: generated/ 

38 

39 dct - Discrete cosine transform 

40 idct - Inverse discrete cosine transform 

41 dctn - N-D Discrete cosine transform 

42 idctn - N-D Inverse discrete cosine transform 

43 dst - Discrete sine transform 

44 idst - Inverse discrete sine transform 

45 dstn - N-D Discrete sine transform 

46 idstn - N-D Inverse discrete sine transform 

47 

48Fast Hankel Transforms 

49====================== 

50 

51.. autosummary:: 

52 :toctree: generated/ 

53 

54 fht - Fast Hankel transform 

55 ifht - Inverse of fht 

56 

57Helper functions 

58================ 

59 

60.. autosummary:: 

61 :toctree: generated/ 

62 

63 fftshift - Shift the zero-frequency component to the center of the spectrum 

64 ifftshift - The inverse of `fftshift` 

65 fftfreq - Return the Discrete Fourier Transform sample frequencies 

66 rfftfreq - DFT sample frequencies (for usage with rfft, irfft) 

67 fhtoffset - Compute an optimal offset for the Fast Hankel Transform 

68 next_fast_len - Find the optimal length to zero-pad an FFT for speed 

69 set_workers - Context manager to set default number of workers 

70 get_workers - Get the current default number of workers 

71 

72Backend control 

73=============== 

74 

75.. autosummary:: 

76 :toctree: generated/ 

77 

78 set_backend - Context manager to set the backend within a fixed scope 

79 skip_backend - Context manager to skip a backend within a fixed scope 

80 set_global_backend - Sets the global fft backend 

81 register_backend - Register a backend for permanent use 

82 

83""" 

84 

85from ._basic import ( 

86 fft, ifft, fft2, ifft2, fftn, ifftn, 

87 rfft, irfft, rfft2, irfft2, rfftn, irfftn, 

88 hfft, ihfft, hfft2, ihfft2, hfftn, ihfftn) 

89from ._realtransforms import dct, idct, dst, idst, dctn, idctn, dstn, idstn 

90from ._fftlog import fhtoffset 

91from ._fftlog_multimethods import fht, ifht 

92from ._helper import next_fast_len 

93from ._backend import (set_backend, skip_backend, set_global_backend, 

94 register_backend) 

95from numpy.fft import fftfreq, rfftfreq, fftshift, ifftshift 

96from ._pocketfft.helper import set_workers, get_workers 

97 

98__all__ = [ 

99 'fft', 'ifft', 'fft2', 'ifft2', 'fftn', 'ifftn', 

100 'rfft', 'irfft', 'rfft2', 'irfft2', 'rfftn', 'irfftn', 

101 'hfft', 'ihfft', 'hfft2', 'ihfft2', 'hfftn', 'ihfftn', 

102 'fftfreq', 'rfftfreq', 'fftshift', 'ifftshift', 

103 'next_fast_len', 

104 'dct', 'idct', 'dst', 'idst', 'dctn', 'idctn', 'dstn', 'idstn', 

105 'fht', 'ifht', 

106 'fhtoffset', 

107 'set_backend', 'skip_backend', 'set_global_backend', 'register_backend', 

108 'get_workers', 'set_workers'] 

109 

110 

111from scipy._lib._testutils import PytestTester 

112test = PytestTester(__name__) 

113del PytestTester