boris-behav-obs 8.16.5__py3-none-any.whl → 9.7.12__py3-none-any.whl

boris/plot_spectrogram_rt.py

@@ -1,7 +1,7 @@
 """
 BORIS
 Behavioral Observation Research Interactive Software
-Copyright 2012-2023 Olivier Friard
+Copyright 2012-2025 Olivier Friard
 
 
   This program is free software; you can redistribute it and/or modify
@@ -24,12 +24,13 @@ Copyright 2012-2023 Olivier Friard
 import wave
 import matplotlib
 
-matplotlib.use("Qt5Agg")
-import numpy as np
+matplotlib.use("QtAgg")
 
+import numpy as np
+from scipy import signal
 from . import config as cfg
 
-from PyQt5.QtWidgets import (
+from PySide6.QtWidgets import (
     QWidget,
     QVBoxLayout,
     QHBoxLayout,
@@ -37,17 +38,15 @@ from PyQt5.QtWidgets import (
     QLabel,
     QSpinBox,
 )
-from PyQt5.QtCore import pyqtSignal, QEvent
-from PyQt5 import Qt
+from PySide6.QtCore import Signal, QEvent, Qt
 from matplotlib.backends.backend_qt5agg import FigureCanvasQTAgg as FigureCanvas
 from matplotlib.figure import Figure
 import matplotlib.ticker as mticker
 
 
 class Plot_spectrogram_RT(QWidget):
-
     # send keypress event to mainwindow
-    sendEvent = pyqtSignal(QEvent)
+    sendEvent = Signal(QEvent)
 
     def __init__(self):
         super().__init__()
@@ -75,7 +74,7 @@ class Plot_spectrogram_RT(QWidget):
                 "+",
                 self,
                 clicked=lambda: self.time_interval_changed(1),
-                focusPolicy=Qt.Qt.NoFocus,
+                focusPolicy=Qt.NoFocus,
             )
         )
         hlayout1.addWidget(
@@ -83,21 +82,17 @@ class Plot_spectrogram_RT(QWidget):
                 "-",
                 self,
                 clicked=lambda: self.time_interval_changed(-1),
-                focusPolicy=Qt.Qt.NoFocus,
+                focusPolicy=Qt.NoFocus,
             )
         )
         layout.addLayout(hlayout1)
 
         hlayout2 = QHBoxLayout()
         hlayout2.addWidget(QLabel("Frequency interval"))
-        self.sb_freq_min = QSpinBox(
-            valueChanged=self.frequency_interval_changed, focusPolicy=Qt.Qt.NoFocus
-        )
+        self.sb_freq_min = QSpinBox(valueChanged=self.frequency_interval_changed, focusPolicy=Qt.NoFocus)
         self.sb_freq_min.setRange(0, 200000)
         self.sb_freq_min.setSingleStep(100)
-        self.sb_freq_max = QSpinBox(
-            valueChanged=self.frequency_interval_changed, focusPolicy=Qt.Qt.NoFocus
-        )
+        self.sb_freq_max = QSpinBox(valueChanged=self.frequency_interval_changed, focusPolicy=Qt.NoFocus)
         self.sb_freq_max.setRange(0, 200000)
         self.sb_freq_max.setSingleStep(100)
         hlayout2.addWidget(self.sb_freq_min)
@@ -118,7 +113,7 @@ class Plot_spectrogram_RT(QWidget):
         else:
             return False
 
-    def get_wav_info(self, wav_file: str):
+    def get_wav_info(self, wav_file: str) -> tuple[np.array, int]:
         """
         read wav file and extract information
 
@@ -134,7 +129,8 @@ class Plot_spectrogram_RT(QWidget):
         try:
             wav = wave.open(wav_file, "r")
             frames = wav.readframes(-1)
-            sound_info = np.fromstring(frames, dtype=np.int16)
+            # sound_info = np.fromstring(frames, dtype=np.int16)
+            sound_info = np.frombuffer(frames, dtype=np.int16)
             frame_rate = wav.getframerate()
             wav.close()
             return sound_info, frame_rate
@@ -187,7 +183,7 @@ class Plot_spectrogram_RT(QWidget):
 
         return {"media_length": self.media_length, "frame_rate": self.frame_rate}
 
-    def plot_spectro(self, current_time: float, force_plot: bool = False):
+    def plot_spectro(self, current_time: float, force_plot: bool = False) -> tuple[float, bool]:
         """
         plot sound spectrogram centered on the current time
 
@@ -203,36 +199,71 @@ class Plot_spectrogram_RT(QWidget):
 
         self.ax.clear()
 
+        window_type = "blackmanharris"  # self.config_param.get(cfg.SPECTROGRAM_WINDOW_TYPE, cfg.SPECTROGRAM_DEFAULT_WINDOW_TYPE)
+        nfft = int(self.config_param.get(cfg.SPECTROGRAM_NFFT, cfg.SPECTROGRAM_DEFAULT_NFFT))
+        noverlap = self.config_param.get(cfg.SPECTROGRAM_NOVERLAP, cfg.SPECTROGRAM_DEFAULT_NOVERLAP)
+        vmin = self.config_param.get(cfg.SPECTROGRAM_VMIN, cfg.SPECTROGRAM_DEFAULT_VMIN)
+        vmax = self.config_param.get(cfg.SPECTROGRAM_VMAX, cfg.SPECTROGRAM_DEFAULT_VMAX)
+
+        if current_time is None:
+            return
+
         # start
         if current_time <= self.interval / 2:
-
             self.ax.specgram(
-                self.sound_info[: int((self.interval) * self.frame_rate)],
+                self.sound_info[: int(self.interval * self.frame_rate)],
                 mode="psd",
-                # NFFT=1024,
+                NFFT=nfft,
                 Fs=self.frame_rate,
-                # noverlap=900,
+                noverlap=noverlap,
+                window=signal.get_window(window_type, nfft),
+                # matplotlib.mlab.window_hanning
+                # if window_type == "hanning"
+                # else matplotlib.mlab.window_hamming
+                # if window_type == "hamming"
+                # else matplotlib.mlab.window_blackmanharris
+                # if window_type == "blackmanharris"
+                # else matplotlib.mlab.window_hanning,
                 cmap=self.spectro_color_map,
+                vmin=vmin,
+                vmax=vmax,
+                # mode="psd",
+                ## NFFT=1024,
+                # Fs=self.frame_rate,
+                ## noverlap=900,
+                # cmap=self.spectro_color_map,
             )
 
-            self.ax.set_xlim(
-                current_time - self.interval / 2, current_time + self.interval / 2
-            )
+            self.ax.set_xlim(current_time - self.interval / 2, current_time + self.interval / 2)
 
             # cursor
             self.ax.axvline(x=current_time, color=self.cursor_color, linestyle="-")
 
         elif current_time >= self.media_length - self.interval / 2:
-
             i = int(round(len(self.sound_info) - (self.interval * self.frame_rate), 0))
 
             self.ax.specgram(
                 self.sound_info[i:],
                 mode="psd",
-                # NFFT=1024,
+                NFFT=nfft,
                 Fs=self.frame_rate,
-                # noverlap=900,
+                noverlap=noverlap,
+                window=signal.get_window(window_type, nfft),
+                # matplotlib.mlab.window_hanning
+                # if window_type == "hanning"
+                # else matplotlib.mlab.window_hamming
+                # if window_type == "hamming"
+                # else matplotlib.mlab.window_blackmanharris
+                # if window_type == "blackmanharris"
+                # else matplotlib.mlab.window_hanning,
                 cmap=self.spectro_color_map,
+                vmin=vmin,
+                vmax=vmax,
+                # mode="psd",
+                ## NFFT=1024,
+                # Fs=self.frame_rate,
+                ## noverlap=900,
+                # cmap=self.spectro_color_map,
             )
 
             lim1 = current_time - (self.media_length - self.interval / 2)
@@ -240,48 +271,44 @@ class Plot_spectrogram_RT(QWidget):
 
             self.ax.set_xlim(lim1, lim2)
 
-            self.ax.xaxis.set_major_locator(
-                mticker.FixedLocator(self.ax.get_xticks().tolist())
-            )
-            self.ax.set_xticklabels(
-                [
-                    str(round(w + self.media_length - self.interval, 1))
-                    for w in self.ax.get_xticks()
-                ]
-            )
+            self.ax.xaxis.set_major_locator(mticker.FixedLocator(self.ax.get_xticks().tolist()))
+            self.ax.set_xticklabels([str(round(w + self.media_length - self.interval, 1)) for w in self.ax.get_xticks()])
 
             # cursor
-            self.ax.axvline(
-                x=lim1 + self.interval / 2, color=self.cursor_color, linestyle="-"
-            )
+            self.ax.axvline(x=lim1 + self.interval / 2, color=self.cursor_color, linestyle="-")
 
         # middle
         else:
-
             self.ax.specgram(
                 self.sound_info[
-                    int(
-                        round((current_time - self.interval / 2) * self.frame_rate, 0)
-                    ) : int(
+                    int(round((current_time - self.interval / 2) * self.frame_rate, 0)) : int(
                         round((current_time + self.interval / 2) * self.frame_rate, 0)
                     )
                 ],
                 mode="psd",
-                # NFFT=1024,
+                NFFT=nfft,
                 Fs=self.frame_rate,
-                # noverlap=900,
+                noverlap=noverlap,
+                window=signal.get_window(window_type, nfft),
+                # matplotlib.mlab.window_hanning
+                # if window_type == "hanning"
+                # else matplotlib.mlab.window_hamming
+                # if window_type == "hamming"
+                # else matplotlib.mlab.window_blackmanharris
+                # if window_type == "blackmanharris"
+                # else matplotlib.mlab.window_hanning,
                 cmap=self.spectro_color_map,
+                vmin=vmin,
+                vmax=vmax,
+                # mode="psd",
+                ## NFFT=1024,
+                # Fs=self.frame_rate,
+                ## noverlap=900,
+                # cmap=self.spectro_color_map,
             )
 
-            self.ax.xaxis.set_major_locator(
-                mticker.FixedLocator(self.ax.get_xticks().tolist())
-            )
-            self.ax.set_xticklabels(
-                [
-                    str(round(current_time + w - self.interval / 2, 1))
-                    for w in self.ax.get_xticks()
-                ]
-            )
+            self.ax.xaxis.set_major_locator(mticker.FixedLocator(self.ax.get_xticks().tolist()))
+            self.ax.set_xticklabels([str(round(current_time + w - self.interval / 2, 1)) for w in self.ax.get_xticks()])
 
             # cursor
             self.ax.axvline(x=self.interval / 2, color=self.cursor_color, linestyle="-")

boris/plot_waveform_rt.py

@@ -1,7 +1,7 @@
 """
 BORIS
 Behavioral Observation Research Interactive Software
-Copyright 2012-2023 Olivier Friard
+Copyright 2012-2025 Olivier Friard
 
 
   This program is free software; you can redistribute it and/or modify
@@ -25,20 +25,21 @@ import wave
 from . import config as cfg
 import matplotlib
 
-matplotlib.use("Qt5Agg")
+matplotlib.use("QtAgg")
+
 import numpy as np
-from PyQt5.QtWidgets import QWidget, QVBoxLayout, QHBoxLayout, QPushButton, QLabel
-from PyQt5.QtCore import pyqtSignal, QEvent
-from PyQt5 import Qt
-from matplotlib.backends.backend_qt5agg import FigureCanvasQTAgg as FigureCanvas
+from PySide6.QtWidgets import QWidget, QVBoxLayout, QHBoxLayout, QPushButton, QLabel
+from PySide6.QtCore import Signal, QEvent, Qt
+from matplotlib.backends.backend_qtagg import FigureCanvasQTAgg as FigureCanvas
 from matplotlib.figure import Figure
 import matplotlib.ticker as mticker
 
+# matplotlib.pyplot.switch_backend("Qt5Agg")
 
-class Plot_waveform_RT(QWidget):
 
+class Plot_waveform_RT(QWidget):
     # send keypress event to mainwindow
-    sendEvent = pyqtSignal(QEvent)
+    sendEvent = Signal(QEvent)
 
     def __init__(self):
         super().__init__()
@@ -66,7 +67,7 @@ class Plot_waveform_RT(QWidget):
                 "+",
                 self,
                 clicked=lambda: self.time_interval_changed(1),
-                focusPolicy=Qt.Qt.NoFocus,
+                focusPolicy=Qt.NoFocus,
             )
         )
         hlayout1.addWidget(
@@ -74,7 +75,7 @@ class Plot_waveform_RT(QWidget):
                 "-",
                 self,
                 clicked=lambda: self.time_interval_changed(-1),
-                focusPolicy=Qt.Qt.NoFocus,
+                focusPolicy=Qt.NoFocus,
             )
         )
         layout.addLayout(hlayout1)
@@ -108,7 +109,8 @@ class Plot_waveform_RT(QWidget):
         try:
             wav = wave.open(wav_file, "r")
             frames = wav.readframes(-1)
-            signal = np.fromstring(frames, dtype=np.int16)
+            # signal = np.fromstring(frames, dtype=np.int16)
+            signal = np.frombuffer(frames, dtype=np.int16)
             frame_rate = wav.getframerate()
             wav.close()
             return signal, frame_rate
@@ -154,7 +156,7 @@ class Plot_waveform_RT(QWidget):
         self.interval += 5 * action
         self.plot_waveform(current_time=self.time_mem, force_plot=True)
 
-    def plot_waveform(self, current_time: float, force_plot: bool = False):
+    def plot_waveform(self, current_time: float, force_plot: bool = False) -> None:
         """
         plot sound waveform centered on the current time
 
@@ -170,28 +172,24 @@ class Plot_waveform_RT(QWidget):
 
         self.ax.clear()
 
+        if current_time is None:
+            return
+
         # start
         if current_time <= self.interval / 2:
-
             time_ = np.linspace(
                 0,
-                len(self.sound_info[: int((self.interval) * self.frame_rate)])
-                / self.frame_rate,
+                len(self.sound_info[: int((self.interval) * self.frame_rate)]) / self.frame_rate,
                 num=len(self.sound_info[: int((self.interval) * self.frame_rate)]),
             )
-            self.ax.plot(
-                time_, self.sound_info[: int((self.interval) * self.frame_rate)]
-            )
+            self.ax.plot(time_, self.sound_info[: int((self.interval) * self.frame_rate)])
 
-            self.ax.set_xlim(
-                current_time - self.interval / 2, current_time + self.interval / 2
-            )
+            self.ax.set_xlim(current_time - self.interval / 2, current_time + self.interval / 2)
 
             # cursor
             self.ax.axvline(x=current_time, color=self.cursor_color, linestyle="-")
 
         elif current_time >= self.media_length - self.interval / 2:
-
             i = int(round(len(self.sound_info) - (self.interval * self.frame_rate), 0))
 
             time_ = np.linspace(
@@ -206,47 +204,27 @@ class Plot_waveform_RT(QWidget):
 
             self.ax.set_xlim(lim1, lim2)
 
-            self.ax.xaxis.set_major_locator(
-                mticker.FixedLocator(self.ax.get_xticks().tolist())
-            )
-            self.ax.set_xticklabels(
-                [
-                    str(round(w + self.media_length - self.interval, 1))
-                    for w in self.ax.get_xticks()
-                ]
-            )
+            self.ax.xaxis.set_major_locator(mticker.FixedLocator(self.ax.get_xticks().tolist()))
+            self.ax.set_xticklabels([str(round(w + self.media_length - self.interval, 1)) for w in self.ax.get_xticks()])
 
             # cursor
-            self.ax.axvline(
-                x=lim1 + self.interval / 2, color=self.cursor_color, linestyle="-"
-            )
+            self.ax.axvline(x=lim1 + self.interval / 2, color=self.cursor_color, linestyle="-")
 
         # middle
         else:
-
             start = (current_time - self.interval / 2) * self.frame_rate
             end = (current_time + self.interval / 2) * self.frame_rate
 
             time_ = np.linspace(
                 0,
-                len(self.sound_info[int(round(start, 0)) : int(round(end, 0))])
-                / self.frame_rate,
+                len(self.sound_info[int(round(start, 0)) : int(round(end, 0))]) / self.frame_rate,
                 num=len(self.sound_info[int(round(start, 0)) : int(round(end, 0))]),
             )
 
-            self.ax.plot(
-                time_, self.sound_info[int(round(start, 0)) : int(round(end, 0))]
-            )
+            self.ax.plot(time_, self.sound_info[int(round(start, 0)) : int(round(end, 0))])
 
-            self.ax.xaxis.set_major_locator(
-                mticker.FixedLocator(self.ax.get_xticks().tolist())
-            )
-            self.ax.set_xticklabels(
-                [
-                    str(round(current_time + w - self.interval / 2, 1))
-                    for w in self.ax.get_xticks()
-                ]
-            )
+            self.ax.xaxis.set_major_locator(mticker.FixedLocator(self.ax.get_xticks().tolist()))
+            self.ax.set_xticklabels([str(round(current_time + w - self.interval / 2, 1)) for w in self.ax.get_xticks()])
 
             # cursor
             self.ax.axvline(x=self.interval / 2, color=self.cursor_color, linestyle="-")