boris-behav-obs 9.7.1__tar.gz → 9.7.2__tar.gz

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boris-behav-obs
-Version: 9.7.1
+Version: 9.7.2
 Summary: BORIS - Behavioral Observation Research Interactive Software
 Author-email: Olivier Friard <olivier.friard@unito.it>
 License-Expression: GPL-3.0-only

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/boris/config.py

@@ -132,6 +132,8 @@ POINT_EVENT_PLOT_COLOR = "black"
 
 CHAR_FORBIDDEN_IN_MODIFIERS = "(|),`~"
 
+FAST_FORWARD_DEFAULT_VALUE:float = 10.0
+
 ADAPT_FAST_JUMP = "adapt_fast_jump"
 ADAPT_FAST_JUMP_DEFAULT = False
 
@@ -419,6 +421,10 @@ MPV_HWDEC_AUTOSAFE = "auto-safe"
 MPV_HWDEC_OPTIONS = (MPV_HWDEC_AUTO, MPV_HWDEC_AUTOSAFE, MPV_HWDEC_NO)
 MPV_HWDEC_DEFAULT_VALUE = MPV_HWDEC_AUTO
 
+# frame step size (disabled)
+# FRAME_STEP_SIZE: str = "frame_step_size"
+# FRAME_STEP_SIZE_DEFAULT_VALUE: int = 1
+
 ANALYSIS_PLUGINS = "analysis_plugins"
 EXCLUDED_PLUGINS = "excluded_plugins"
 PERSONAL_PLUGINS_DIR = "personal_plugins_dir"
@@ -730,6 +736,7 @@ INIT_PARAM = {
     MPV_HWDEC: MPV_HWDEC_DEFAULT_VALUE,
     PROJECT_FILE_INDENTATION: PROJECT_FILE_INDENTATION_DEFAULT_VALUE,
     f"{MEDIA} tw fields": MEDIA_TW_EVENTS_FIELDS_DEFAULT,
+    # FRAME_STEP_SIZE: FRAME_STEP_SIZE_DEFAULT_VALUE,
 }
 
 SDIS_EXT = "sds"

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/boris/config_file.py

@@ -82,11 +82,11 @@ def read(self):
 
         logging.debug(f"time format: {self.timeFormat}")
 
-        self.fast = 10
+        self.fast = cfg.FAST_FORWARD_DEFAULT_VALUE
         try:
-            self.fast = int(settings.value("Time/fast_forward_speed"))
+            self.fast = float(settings.value("Time/fast_forward_speed"))
         except Exception:
-            self.fast = 10
+            self.fast = cfg.FAST_FORWARD_DEFAULT_VALUE
 
         logging.debug(f"Time/fast_forward_speed: {self.fast}")
 

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/boris/core.py

@@ -43,7 +43,6 @@ import locale
 import tempfile
 import time
 import urllib.request
-from typing import Union, Tuple
 from decimal import Decimal as dec
 from decimal import ROUND_DOWN
 import gzip
@@ -242,7 +241,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
     current_player: int = 0  # id of the selected (left click) video player
 
     mem_media_name: str = ""  # record current media name. Use to check if media changed
-    mem_playlist_index: Union[int, None] = None
+    mem_playlist_index: int | None = None
     saved_state = None
     user_move_slider: bool = False
     observationId: str = ""  # current observation id
@@ -739,7 +738,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         text: str = "Behaviors to show in ethogram list",
         table: str = cfg.ETHOGRAM,
         behavior_type: list = cfg.STATE_EVENT_TYPES,
-    ) -> Tuple[bool, list]:
+    ) -> tuple[bool, list]:
         """
         allow user to:
             filter behaviors in ethogram widget
@@ -3682,14 +3681,18 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         """
         show next frame
         """
+        # frame_step_size = self.config_param.get(cfg.FRAME_STEP_SIZE, cfg.FRAME_STEP_SIZE_DEFAULT_VALUE)
+
         if self.playerType == cfg.IMAGES:
             if self.image_idx < len(self.images_list) - 1:
-                self.image_idx += 1
+                self.image_idx += 1  # frame_step_size
                 self.extract_frame(self.dw_player[0])
 
         if self.playerType == cfg.MEDIA:
             for dw in self.dw_player:
+                # for _ in range(frame_step_size):
                 dw.player.frame_step()
+                # time.sleep(0.5)
 
                 if self.geometric_measurements_mode:
                     self.extract_frame(dw)
@@ -3866,7 +3869,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                 write_event.write_event(self, event, cumulative_time)
             # write_event.write_event(self, event, self.getLaps())
 
-    def get_frame_index(self, player_idx: int = 0) -> Union[int, str]:
+    def get_frame_index(self, player_idx: int = 0) -> int | str:
         """
         returns frame index for player player_idx
         """
@@ -4142,7 +4145,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                 self.dw_player[n_player].player.playlist_pos = self.dw_player[n_player].player.playlist_count - 1
                 self.seek_mediaplayer(self.dw_player[n_player].media_durations[-1], player=n_player)
 
-    def mpv_timer_out(self, value: Union[float, None] = None, scroll_slider=True):
+    def mpv_timer_out(self, value: float | None = None, scroll_slider=True):
         """
         print the media current position and total length for MPV player
         scroll video slider to video position
@@ -4152,13 +4155,9 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         if not self.observationId:
             return
 
-        print("mpv timer out")
-
         cumulative_time_pos = self.getLaps()
-        print(f"{cumulative_time_pos=}")
         # get frame index
         frame_idx = self.get_frame_index()
-        print(f"{frame_idx=}")
         # frame_idx = 0
 
         if value is None:  # ipc mpv
@@ -4237,9 +4236,6 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         self.show_current_states_in_subjects_table()
 
         # current media name
-        print(f"{self.dw_player[0].player.playlist_pos=}")
-        print(f"{self.dw_player[0].player.playlist=}")
-
         if self.dw_player[0].player.playlist_pos is not None:
             current_media_name = Path(self.dw_player[0].player.playlist[self.dw_player[0].player.playlist_pos]["filename"]).name
             current_playlist_index = self.dw_player[0].player.playlist_pos
@@ -4488,7 +4484,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                 for x in self.pj[cfg.OBSERVATIONS][obs_id][cfg.EVENTS]
             )
 
-    def choose_behavior(self, obs_key) -> Union[None, str]:
+    def choose_behavior(self, obs_key) -> None | str:
         """
         fill listwidget with all behaviors coded by key
 
@@ -4520,7 +4516,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
             else:
                 return None
 
-    def choose_subject(self, subject_key) -> Union[None, str]:
+    def choose_subject(self, subject_key) -> None | str:
         """
         fill listwidget with all subjects coded by key
 
@@ -4608,7 +4604,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
 
                 return dec(str(round(mem_laps / 1000, 3)))
 
-    def get_obs_time(self, n_player: int = 0) -> Tuple[dec, dec | None]:
+    def get_obs_time(self, n_player: int = 0) -> tuple[dec, dec | None]:
         """
         returns time in current media and cumulative time from begining of observation
         do not add time offset

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/boris/preferences.py

@@ -221,6 +221,9 @@ def preferences(self):
     preferencesWindow.cbConfirmSound.setChecked(self.confirmSound)
     # beep every
     preferencesWindow.sbBeepEvery.setValue(self.beep_every)
+    # frame step size
+    #preferencesWindow.sb_frame_step_size.setValue(self.config_param.get(cfg.FRAME_STEP_SIZE, cfg.FRAME_STEP_SIZE_DEFAULT_VALUE))
+
     # alert no focal subject
     preferencesWindow.cbAlertNoFocalSubject.setChecked(self.alertNoFocalSubject)
     # tracking cursor above event
@@ -418,6 +421,9 @@ def preferences(self):
 
             self.beep_every = preferencesWindow.sbBeepEvery.value()
 
+            # frame step size
+            #self.config_param[cfg.FRAME_STEP_SIZE] = preferencesWindow.sb_frame_step_size.value()
+
             self.alertNoFocalSubject = preferencesWindow.cbAlertNoFocalSubject.isChecked()
 
             self.trackingCursorAboveEvent = preferencesWindow.cbTrackingCursorAboveEvent.isChecked()

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/boris/preferences_ui.py

@@ -3,7 +3,7 @@
 ################################################################################
 ## Form generated from reading UI file 'preferences.ui'
 ##
-## Created by: Qt User Interface Compiler version 6.9.0
+## Created by: Qt User Interface Compiler version 6.10.0
 ##
 ## WARNING! All changes made in this file will be lost when recompiling UI file!
 ################################################################################
@@ -145,11 +145,8 @@ class Ui_prefDialog(object):
 
         self.horizontalLayout_4.addWidget(self.label_4)
 
-        self.sbffSpeed = QSpinBox(self.tab_observations)
+        self.sbffSpeed = QDoubleSpinBox(self.tab_observations)
         self.sbffSpeed.setObjectName(u"sbffSpeed")
-        self.sbffSpeed.setMinimum(0)
-        self.sbffSpeed.setMaximum(10000)
-        self.sbffSpeed.setValue(10)
 
         self.horizontalLayout_4.addWidget(self.sbffSpeed)
 
@@ -244,6 +241,26 @@ class Ui_prefDialog(object):
 
         self.verticalLayout.addWidget(self.cb_pause_before_addevent)
 
+        self.horizontalLayout_23 = QHBoxLayout()
+        self.horizontalLayout_23.setObjectName(u"horizontalLayout_23")
+        self.label_24 = QLabel(self.tab_observations)
+        self.label_24.setObjectName(u"label_24")
+        self.label_24.setEnabled(False)
+
+        self.horizontalLayout_23.addWidget(self.label_24)
+
+        self.sb_frame_step_size = QSpinBox(self.tab_observations)
+        self.sb_frame_step_size.setObjectName(u"sb_frame_step_size")
+        self.sb_frame_step_size.setEnabled(False)
+        self.sb_frame_step_size.setMinimum(1)
+        self.sb_frame_step_size.setMaximum(1000)
+        self.sb_frame_step_size.setValue(1)
+
+        self.horizontalLayout_23.addWidget(self.sb_frame_step_size)
+
+
+        self.verticalLayout.addLayout(self.horizontalLayout_23)
+
         self.verticalSpacer_4 = QSpacerItem(20, 391, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Expanding)
 
         self.verticalLayout.addItem(self.verticalSpacer_4)
@@ -256,35 +273,35 @@ class Ui_prefDialog(object):
         self.splitter_2 = QSplitter(self.tab_analysis_plugins)
         self.splitter_2.setObjectName(u"splitter_2")
         self.splitter_2.setOrientation(Qt.Orientation.Horizontal)
-        self.widget = QWidget(self.splitter_2)
-        self.widget.setObjectName(u"widget")
-        self.verticalLayout_11 = QVBoxLayout(self.widget)
+        self.layoutWidget = QWidget(self.splitter_2)
+        self.layoutWidget.setObjectName(u"layoutWidget")
+        self.verticalLayout_11 = QVBoxLayout(self.layoutWidget)
         self.verticalLayout_11.setObjectName(u"verticalLayout_11")
         self.verticalLayout_11.setContentsMargins(0, 0, 0, 0)
-        self.label_13 = QLabel(self.widget)
+        self.label_13 = QLabel(self.layoutWidget)
         self.label_13.setObjectName(u"label_13")
 
         self.verticalLayout_11.addWidget(self.label_13)
 
-        self.lv_all_plugins = QListWidget(self.widget)
+        self.lv_all_plugins = QListWidget(self.layoutWidget)
         self.lv_all_plugins.setObjectName(u"lv_all_plugins")
 
         self.verticalLayout_11.addWidget(self.lv_all_plugins)
 
-        self.label_15 = QLabel(self.widget)
+        self.label_15 = QLabel(self.layoutWidget)
         self.label_15.setObjectName(u"label_15")
 
         self.verticalLayout_11.addWidget(self.label_15)
 
         self.horizontalLayout_16 = QHBoxLayout()
         self.horizontalLayout_16.setObjectName(u"horizontalLayout_16")
-        self.le_personal_plugins_dir = QLineEdit(self.widget)
+        self.le_personal_plugins_dir = QLineEdit(self.layoutWidget)
         self.le_personal_plugins_dir.setObjectName(u"le_personal_plugins_dir")
         self.le_personal_plugins_dir.setReadOnly(True)
 
         self.horizontalLayout_16.addWidget(self.le_personal_plugins_dir)
 
-        self.pb_browse_plugins_dir = QPushButton(self.widget)
+        self.pb_browse_plugins_dir = QPushButton(self.layoutWidget)
         self.pb_browse_plugins_dir.setObjectName(u"pb_browse_plugins_dir")
 
         self.horizontalLayout_16.addWidget(self.pb_browse_plugins_dir)
@@ -292,49 +309,49 @@ class Ui_prefDialog(object):
 
         self.verticalLayout_11.addLayout(self.horizontalLayout_16)
 
-        self.lw_personal_plugins = QListWidget(self.widget)
+        self.lw_personal_plugins = QListWidget(self.layoutWidget)
         self.lw_personal_plugins.setObjectName(u"lw_personal_plugins")
 
         self.verticalLayout_11.addWidget(self.lw_personal_plugins)
 
-        self.splitter_2.addWidget(self.widget)
+        self.splitter_2.addWidget(self.layoutWidget)
         self.splitter = QSplitter(self.splitter_2)
         self.splitter.setObjectName(u"splitter")
         self.splitter.setOrientation(Qt.Orientation.Vertical)
-        self.widget1 = QWidget(self.splitter)
-        self.widget1.setObjectName(u"widget1")
-        self.verticalLayout_12 = QVBoxLayout(self.widget1)
+        self.layoutWidget1 = QWidget(self.splitter)
+        self.layoutWidget1.setObjectName(u"layoutWidget1")
+        self.verticalLayout_12 = QVBoxLayout(self.layoutWidget1)
         self.verticalLayout_12.setObjectName(u"verticalLayout_12")
         self.verticalLayout_12.setContentsMargins(0, 0, 0, 0)
-        self.label_14 = QLabel(self.widget1)
+        self.label_14 = QLabel(self.layoutWidget1)
         self.label_14.setObjectName(u"label_14")
 
         self.verticalLayout_12.addWidget(self.label_14)
 
-        self.pte_plugin_description = QPlainTextEdit(self.widget1)
+        self.pte_plugin_description = QPlainTextEdit(self.layoutWidget1)
         self.pte_plugin_description.setObjectName(u"pte_plugin_description")
         self.pte_plugin_description.setReadOnly(True)
 
         self.verticalLayout_12.addWidget(self.pte_plugin_description)
 
-        self.splitter.addWidget(self.widget1)
-        self.widget2 = QWidget(self.splitter)
-        self.widget2.setObjectName(u"widget2")
-        self.verticalLayout_14 = QVBoxLayout(self.widget2)
+        self.splitter.addWidget(self.layoutWidget1)
+        self.layoutWidget2 = QWidget(self.splitter)
+        self.layoutWidget2.setObjectName(u"layoutWidget2")
+        self.verticalLayout_14 = QVBoxLayout(self.layoutWidget2)
         self.verticalLayout_14.setObjectName(u"verticalLayout_14")
         self.verticalLayout_14.setContentsMargins(0, 0, 0, 0)
-        self.label_23 = QLabel(self.widget2)
+        self.label_23 = QLabel(self.layoutWidget2)
         self.label_23.setObjectName(u"label_23")
 
         self.verticalLayout_14.addWidget(self.label_23)
 
-        self.pte_plugin_code = QPlainTextEdit(self.widget2)
+        self.pte_plugin_code = QPlainTextEdit(self.layoutWidget2)
         self.pte_plugin_code.setObjectName(u"pte_plugin_code")
         self.pte_plugin_code.setLineWrapMode(QPlainTextEdit.LineWrapMode.NoWrap)
 
         self.verticalLayout_14.addWidget(self.pte_plugin_code)
 
-        self.splitter.addWidget(self.widget2)
+        self.splitter.addWidget(self.layoutWidget2)
         self.splitter_2.addWidget(self.splitter)
 
         self.verticalLayout_15.addWidget(self.splitter_2)
@@ -676,7 +693,7 @@ class Ui_prefDialog(object):
 
         self.retranslateUi(prefDialog)
 
-        self.tabWidget.setCurrentIndex(2)
+        self.tabWidget.setCurrentIndex(1)
 
 
         QMetaObject.connectSlotsByName(prefDialog)
@@ -707,6 +724,7 @@ class Ui_prefDialog(object):
         self.cbTrackingCursorAboveEvent.setText(QCoreApplication.translate("prefDialog", u"Tracking cursor above current event", None))
         self.cbAlertNoFocalSubject.setText(QCoreApplication.translate("prefDialog", u"Alert if focal subject is not set", None))
         self.cb_pause_before_addevent.setText(QCoreApplication.translate("prefDialog", u"Pause media before \"Add event\" command", None))
+        self.label_24.setText(QCoreApplication.translate("prefDialog", u"Frame step size", None))
         self.tabWidget.setTabText(self.tabWidget.indexOf(self.tab_observations), QCoreApplication.translate("prefDialog", u"Observations", None))
         self.label_13.setText(QCoreApplication.translate("prefDialog", u"BORIS plugins", None))
         self.label_15.setText(QCoreApplication.translate("prefDialog", u"Personal plugins", None))

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/boris/project_functions.py

@@ -1425,6 +1425,7 @@ def open_project_json(project_file_name: str) -> tuple:
                 pj[cfg.OBSERVATIONS][obs][cfg.TYPE] = cfg.MEDIA
 
             # convert old media list in new one
+            d1: dict = {}
             if len(pj[cfg.OBSERVATIONS][obs][cfg.FILE]):
                 d1 = {cfg.PLAYER1: [pj[cfg.OBSERVATIONS][obs][cfg.FILE][0]]}
 
@@ -1470,6 +1471,13 @@ def open_project_json(project_file_name: str) -> tuple:
             pj[cfg.PROJECT_VERSION] = cfg.project_format_version
             projectChanged = True
 
+    # check if behavioral categories are stored as a list
+    if isinstance(pj[cfg.BEHAVIORAL_CATEGORIES_CONF], list):
+        # convert to dict
+        pj[cfg.BEHAVIORAL_CATEGORIES_CONF] = {str(idx): {"name": bc} for idx, bc in enumerate(pj[cfg.BEHAVIORAL_CATEGORIES_CONF])}
+        logging.info("Behavioral categories was converted from a list to a dictionary")
+        projectChanged = True
+
     # add category key if not found
     for idx in pj[cfg.ETHOGRAM]:
         if cfg.BEHAVIOR_CATEGORY not in pj[cfg.ETHOGRAM][idx]:

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/boris/version.py

@@ -20,5 +20,5 @@ This file is part of BORIS.
 
 """
 
-__version__ = "9.7.1"
-__version_date__ = "2025-10-22"
+__version__ = "9.7.2"
+__version_date__ = "2025-10-24"

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/boris_behav_obs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boris-behav-obs
-Version: 9.7.1
+Version: 9.7.2
 Summary: BORIS - Behavioral Observation Research Interactive Software
 Author-email: Olivier Friard <olivier.friard@unito.it>
 License-Expression: GPL-3.0-only

{boris_behav_obs-9.7.1 → boris_behav_obs-9.7.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boris-behav-obs"
-version = "9.7.1"
+version = "9.7.2"
 description = "BORIS - Behavioral Observation Research Interactive Software"
 authors = [{ name="Olivier Friard", email="olivier.friard@unito.it" }]
 readme = "README.md"