hiro/fibre_walk_project_code
1
0
Fork 0
mirror of https://github.com/vale981/fibre_walk_project_code synced 2025-03-05 09:51:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

CHORE: Document fft helper

Browse source
This commit is contained in:
Valentin Boettcher 2024-05-21 17:03:55 -04:00
parent 8706404b50
commit 393610e0cc
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/rabifun/analysis.py
View file

@ -2,12 +2,17 @@ import numpy as np
def fourier_transform( def fourier_transform(
t: np.ndarray, signal: np.ndarray, window: tuple[float, float] | None = None t: np.ndarray,
signal: np.ndarray,
window: tuple[float, float] | None = None,
low_cutoff: float = 0,
high_cutoff: float = np.inf,
): ):
""" """
Compute the Fourier transform of a signal from the time array Compute the Fourier transform of a signal from the time array
``t`` and the real signal ``signal``. Optionally, a time window ``t`` and the real signal ``signal``. Optionally, a time window
can be specified through ``window = ([begin], [end])`` . can be specified through ``window = ([begin], [end])`` . The
``low_cuttof (high_cutoff)`` is the lower (upper) bound of frequencies returned.
:returns: The (linear) frequency array and the Fourier transform. :returns: The (linear) frequency array and the Fourier transform.
""" """
@ -20,4 +25,5 @@ def fourier_transform(
freq = np.fft.rfftfreq(len(t), t[1] - t[0]) freq = np.fft.rfftfreq(len(t), t[1] - t[0])
fft = np.fft.rfft(signal) fft = np.fft.rfft(signal)
return freq, fft mask = (freq > low_cutoff) & (freq < high_cutoff)
return freq[mask], fft[mask]