Skip to content

Commit a5d2983

Browse files
authored
Merge pull request #74 from Eden-Kramer-Lab/copilot/fix-multitaper-docstring
Fix n_fft_samples docstring: uses next_fast_len, not next power of 2
2 parents 2f6a738 + 64de799 commit a5d2983

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

spectral_connectivity/transforms.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,9 @@ class Multitaper:
504504
start_time : float or NDArray[floating], default=0
505505
Start time in seconds of the time series data.
506506
n_fft_samples : int, optional
507-
Length of FFT. If None, uses next power of 2 >= n_time_samples_per_window.
507+
Length of FFT. If None, uses a value >= n_time_samples_per_window chosen
508+
to be fast for the FFT algorithm. The value is determined by
509+
scipy.fft.next_fast_len (or cupy.fft.next_fast_len when GPU is enabled).
508510
n_time_samples_per_window : int, optional
509511
Number of samples per time window. Computed from time_window_duration
510512
if not provided.

0 commit comments

Comments
 (0)