attempt to fix error with istft in example

added todo for stft_tukey return value

Author: tyler

docs/examples_tutorial/e00_intro_set/s02_tone_stft_vs_spectrogram.py

@@ -94,15 +94,24 @@
     time_spect_s = time_spect_s - time_spect_s[0]
 
     # Compute the spectrogram with the stft option
-    frequency_stft_hz, time_stft_s, stft_complex = stft.stft_tukey(
-        timeseries=mic_sig,
+    stft_obj = stft.get_stft_object_tukey(
         sample_rate_hz=frequency_sample_rate_hz,
         tukey_alpha=alpha,
         segment_length=time_fft_nd,
         overlap_length=time_fft_nd // 2,  # 50% overlap
         scaling="magnitude",
-        padding="zeros",
     )
+    stft_complex = stft_obj.stft(mic_sig, padding="zeros")
+
+    stft_magnitude = np.abs(stft_obj.stft_detrend(x=mic_sig, detr="constant", padding="zeros"))
+    # calculate the time and frequency bins
+    time_stft_s = np.arange(start=0, stop=stft_obj.delta_t * np.shape(stft_magnitude)[1], step=stft_obj.delta_t)
+    frequency_stft_hz = stft_obj.f
+
+    # frequency_stft_hz, time_stft_s, stft_complex = stft.stft_tukey(
+    #     timeseries=mic_sig,
+    #     padding="zeros",
+    # )
     # Since one-sided, multiply by 2 to get the full power
     stft_power = 2 * np.abs(stft_complex) ** 2
 

quantum_inferno/utilities/short_time_fft.py

@@ -60,6 +60,7 @@ def get_stft_object_tukey(
     return stft_obj
 
 
+#todo: check for ways to return the stft object instead of the magnitude and rewrite calls to the function
 def stft_tukey(
     timeseries: np.ndarray,
     sample_rate_hz: Union[float, int],
@@ -72,6 +73,7 @@ def stft_tukey(
     """
     Calculate the Short-Time Fourier Transform (STFT) of a signal with a Tukey window using ShortTimeFFT class
     Returns the frequency, time bins, and magnitude of the STFT similar to legacy scipy.signal.stft
+    NOTE: the stft_detrend method used to get the magnitude makes it unable to be inverted using istft_tukey
 
     :param timeseries: input signal
     :param sample_rate_hz: sample rate of the signal