xorbits.numpy.fft.fftfreq#

xorbits.numpy.fft.fftfreq(n, d=1.0, gpu=None, chunk_size=None)[source]#

Return the Discrete Fourier Transform sample frequencies.

The returned float array f contains the frequency bin centers in cycles per unit of the sample spacing (with zero at the start). For instance, if the sample spacing is in seconds, then the frequency unit is cycles/second.

Given a window length n and a sample spacing d:

f = [0, 1, ...,   n/2-1,     -n/2, ..., -1] / (d*n)   if n is even
f = [0, 1, ..., (n-1)/2, -(n-1)/2, ..., -1] / (d*n)   if n is odd

Parameters

n (int) – Window length.
d (scalar, optional) – Sample spacing (inverse of the sampling rate). Defaults to 1.

Returns

f – Array of length n containing the sample frequencies.

Return type

ndarray

Examples

>>> signal = np.array([-2, 8, 6, 4, 1, 0, 3, 5], dtype=float)  
>>> fourier = np.fft.fft(signal)  
>>> n = signal.size  
>>> timestep = 0.1  
>>> freq = np.fft.fftfreq(n, d=timestep)  
>>> freq  
array([ 0.  ,  1.25,  2.5 , ..., -3.75, -2.5 , -1.25])

gpubool, optional: Allocate the tensor on GPU if True, False as default
chunk_sizeint or tuple of int or tuple of ints, optional: Desired chunk size on each dimension

This docstring was copied from numpy.fft.