boris-behav-obs 9.7.7__py3-none-any.whl

boris/select_modifiers.py

@@ -0,0 +1,312 @@
+"""
+BORIS
+Behavioral Observation Research Interactive Software
+Copyright 2012-2025 Olivier Friard
+
+This file is part of BORIS.
+
+  BORIS is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 3 of the License, or
+  any later version.
+
+  BORIS is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not see <http://www.gnu.org/licenses/>.
+
+"""
+
+import re
+
+from PySide6.QtCore import Qt, QEvent
+from PySide6.QtWidgets import (
+    QDialog,
+    QVBoxLayout,
+    QLabel,
+    QListWidget,
+    QHBoxLayout,
+    QLineEdit,
+    QPushButton,
+    QListWidgetItem,
+    QSizePolicy,
+    QSpacerItem,
+    QAbstractItemView,
+    QMessageBox,
+)
+
+from . import config as cfg
+from . import utilities as util
+
+
+class ModifiersList(QDialog):
+    """
+    class for selection the modifier(s)
+    """
+
+    def __init__(self, code: str, modifiers_dict: dict, currentModifier: str):
+        super().__init__()
+        self.setWindowTitle(cfg.programName)
+        self.setWindowFlags(Qt.WindowStaysOnTopHint)
+
+        self.modifiers_dict = dict(modifiers_dict)
+        currentModifierList = currentModifier.split("|")
+
+        V1layout = QVBoxLayout()
+        label = QLabel()
+        label.setText(f"Choose the modifier{'s' * (len(self.modifiers_dict) > 1)} for <b>{code}</b> behavior")
+        V1layout.addWidget(label)
+
+        Hlayout = QHBoxLayout()
+        self.modifiersSetNumber = 0
+
+        for idx in util.sorted_keys(modifiers_dict):
+            if self.modifiers_dict[idx]["type"] not in (
+                cfg.SINGLE_SELECTION,
+                cfg.MULTI_SELECTION,
+                cfg.NUMERIC_MODIFIER,
+            ):
+                continue
+
+            V2layout = QVBoxLayout()
+
+            self.modifiersSetNumber += 1
+
+            if self.modifiers_dict[idx].get("name", ""):
+                lb1 = QLabel(f"Modifier <b>{self.modifiers_dict[idx].get('name', '')}</b>")
+                V2layout.addWidget(lb1)
+
+            if self.modifiers_dict[idx].get("description", ""):
+                lb2 = QLabel(f"<small>{self.modifiers_dict[idx].get('description', '')[:50]}</small>")
+                V2layout.addWidget(lb2)
+
+            if self.modifiers_dict[idx]["type"] in (
+                cfg.SINGLE_SELECTION,
+                cfg.MULTI_SELECTION,
+            ):
+                lw = QListWidget()
+                self.modifiers_dict[idx]["widget"] = lw
+                lw.setObjectName(f"lw_modifiers_({self.modifiers_dict[idx]['type']})")
+                lw.installEventFilter(self)
+
+                if self.modifiers_dict[idx]["type"] == cfg.SINGLE_SELECTION:
+                    item = QListWidgetItem("None")
+                    lw.addItem(item)
+                    item.setSelected(True)
+
+                for modifier in self.modifiers_dict[idx]["values"]:
+                    item = QListWidgetItem(modifier)
+                    if self.modifiers_dict[idx]["type"] == cfg.MULTI_SELECTION:
+                        item.setCheckState(Qt.Unchecked)
+
+                        # previously selected
+                        try:
+                            if currentModifierList != [""] and re.sub(r" \(.\)", "", modifier) in currentModifierList[int(idx)].split(","):
+                                item.setCheckState(Qt.Checked)
+                        except Exception:  # for old projects due to a fixed bug
+                            pass
+
+                    lw.addItem(item)
+
+                    if self.modifiers_dict[idx]["type"] == cfg.SINGLE_SELECTION:
+                        try:
+                            if currentModifierList != [""] and re.sub(r" \(.\)", "", modifier) == currentModifierList[int(idx)]:
+                                item.setSelected(True)
+                        except Exception:  # for old projects due to a fixed bug
+                            pass
+                V2layout.addWidget(lw)
+
+            if self.modifiers_dict[idx]["type"] in [cfg.NUMERIC_MODIFIER]:
+                le = QLineEdit()
+                self.modifiers_dict[idx]["widget"] = le
+                le.setObjectName(f"le_modifiers_({self.modifiers_dict[idx]['type']})")
+
+                if currentModifierList != [""] and currentModifierList[int(idx)] != "None":
+                    le.setText(currentModifierList[int(idx)])
+
+                V2layout.addWidget(le)
+
+                # vertical spacer
+                spacerItem = QSpacerItem(20, 40, QSizePolicy.Minimum, QSizePolicy.Expanding)
+                V2layout.addItem(spacerItem)
+
+            Hlayout.addLayout(V2layout)
+
+        V1layout.addLayout(Hlayout)
+
+        H2layout = QHBoxLayout()
+        H2layout.addStretch(1)
+
+        pbCancel = QPushButton(cfg.CANCEL)
+        pbCancel.clicked.connect(self.reject)
+        H2layout.addWidget(pbCancel)
+
+        pbOK = QPushButton(cfg.OK)
+        pbOK.setDefault(True)
+        pbOK.clicked.connect(self.pbOK_clicked)
+        H2layout.addWidget(pbOK)
+
+        V1layout.addLayout(H2layout)
+        self.setLayout(V1layout)
+
+        self.installEventFilter(self)
+        self.setMaximumSize(1024, 960)
+
+    def eventFilter(self, receiver, event):
+        """
+        send event (if keypress) to main window
+        """
+        if event.type() == QEvent.KeyPress:
+            ek, ek_text = event.key(), event.text()
+
+            # reject and close dialog if escape pressed
+            if ek == Qt.Key_Escape:  # close
+                self.reject()
+                return False
+
+            # accept and close dialog if enter pressed
+            if ek == Qt.Key_Enter or ek == Qt.Key_Return:  # enter or enter from numeric pad
+                if not self.pbOK_clicked():
+                    return False
+                return True
+
+            modifiersSetIndex = 0
+            for widget in self.children():
+                if "_modifiers" in widget.objectName():
+                    modifiersSetIndex = modifiersSetIndex + 1
+                if "lw_modifiers" in widget.objectName():
+                    if self.modifiersSetNumber == 1:
+                        # check if modifiers have code
+                        for index in range(widget.count()):
+                            if "(" in widget.item(index).text():
+                                break
+                        else:
+                            # modifiers have no associated code: the modifier starting with hit key will be selected
+                            if ek not in (Qt.Key_Down, Qt.Key_Up):
+                                if ek == Qt.Key_Space and f"({cfg.MULTI_SELECTION})" in widget.objectName():  # checking using SPACE bar
+                                    if widget.item(widget.currentRow()).checkState() == Qt.Checked:
+                                        widget.item(widget.currentRow()).setCheckState(Qt.Unchecked)
+                                    else:
+                                        widget.item(widget.currentRow()).setCheckState(Qt.Checked)
+
+                                else:
+                                    for index in range(widget.count()):
+                                        if widget.item(index).text().upper().startswith(ek_text.upper()):
+                                            widget.setCurrentRow(index)
+                                            widget.scrollToItem(
+                                                widget.item(index),
+                                                QAbstractItemView.EnsureVisible,
+                                            )
+                                            return True
+                            else:  # up / down keys
+                                try:
+                                    if ek == Qt.Key_Down and widget.currentRow() < widget.count() - 1:
+                                        widget.setCurrentRow(widget.currentRow() + 1)
+                                    if ek == Qt.Key_Up and widget.currentRow() > 0:
+                                        widget.setCurrentRow(widget.currentRow() - 1)
+                                except Exception:
+                                    return
+
+                    for index in range(widget.count()):
+                        # check function kesy (F1, F2...)
+                        if ek in cfg.function_keys:
+                            if f"({cfg.function_keys[ek]})" in widget.item(index).text().upper():
+                                if f"({cfg.SINGLE_SELECTION})" in widget.objectName():
+                                    widget.item(index).setSelected(True)
+                                    # close dialog if one set of modifiers
+                                    if self.modifiersSetNumber == 1:
+                                        self.accept()
+                                        return True
+                                    # else move to next set of mofifiers
+                                    elif modifiersSetIndex != self.modifiersSetNumber:
+                                        widget.parent().focusNextChild()
+                                        return True
+
+                                if f"({cfg.MULTI_SELECTION})" in widget.objectName():
+                                    if widget.item(index).checkState() == Qt.Checked:
+                                        widget.item(index).setCheckState(Qt.Unchecked)
+                                    else:
+                                        widget.item(index).setCheckState(Qt.Checked)
+
+                        if ek < 1114112 and f"({ek_text})" in widget.item(index).text():
+                            if f"({cfg.SINGLE_SELECTION})" in widget.objectName():
+                                widget.item(index).setSelected(True)
+                                # close dialog if one set of modifiers
+                                if self.modifiersSetNumber == 1:
+                                    self.accept()
+                                    return True
+                                # else move to next set of mofifiers
+                                elif modifiersSetIndex != self.modifiersSetNumber:
+                                    widget.parent().focusNextChild()
+                                    return True
+
+                            if f"({cfg.MULTI_SELECTION})" in widget.objectName():
+                                if widget.item(index).checkState() == Qt.Checked:
+                                    widget.item(index).setCheckState(Qt.Unchecked)
+                                else:
+                                    widget.item(index).setCheckState(Qt.Checked)
+
+            return True
+        else:
+            return False
+
+    def get_modifiers(self):
+        """
+        get modifiers
+        returns list of selected modifiers
+        """
+
+        for idx in util.sorted_keys(self.modifiers_dict):
+            if self.modifiers_dict[idx]["type"] in [
+                cfg.SINGLE_SELECTION,
+                cfg.MULTI_SELECTION,
+                cfg.NUMERIC_MODIFIER,
+            ]:
+                self.modifiers_dict[idx]["selected"] = []
+
+            if self.modifiers_dict[idx]["type"] == cfg.MULTI_SELECTION:
+                for j in range(self.modifiers_dict[idx]["widget"].count()):
+                    if self.modifiers_dict[idx]["widget"].item(j).checkState() == Qt.Checked:
+                        self.modifiers_dict[idx]["selected"].append(
+                            re.sub(
+                                r" \(.*\)",
+                                "",
+                                self.modifiers_dict[idx]["widget"].item(j).text(),
+                            )
+                        )
+
+                if not self.modifiers_dict[idx]["selected"]:
+                    self.modifiers_dict[idx]["selected"].append("None")
+
+            if self.modifiers_dict[idx]["type"] == cfg.SINGLE_SELECTION:
+                for item in self.modifiers_dict[idx]["widget"].selectedItems():
+                    self.modifiers_dict[idx]["selected"].append(re.sub(r" \(.*\)", "", item.text()))
+
+            if self.modifiers_dict[idx]["type"] == cfg.NUMERIC_MODIFIER:
+                self.modifiers_dict[idx]["selected"] = (
+                    self.modifiers_dict[idx]["widget"].text() if self.modifiers_dict[idx]["widget"].text() else "None"
+                )
+
+        return self.modifiers_dict
+
+    def pbOK_clicked(self):
+        """
+        OK button is clicked
+        """
+        for idx in util.sorted_keys(self.modifiers_dict):
+            if self.modifiers_dict[idx]["type"] == cfg.NUMERIC_MODIFIER:
+                if self.modifiers_dict[idx]["widget"].text():
+                    try:
+                        _ = float(self.modifiers_dict[idx]["widget"].text())
+                    except Exception:
+                        QMessageBox.warning(
+                            self,
+                            cfg.programName,
+                            f"<b>{self.modifiers_dict[idx]['widget'].text()}</b> is not a numeric value",
+                        )
+                        return False
+
+        self.accept()

boris/select_observations.py

@@ -0,0 +1,210 @@
+"""
+BORIS
+Behavioral Observation Research Interactive Software
+Copyright 2012-2025 Olivier Friard
+
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+  MA 02110-1301, USA.
+
+"""
+
+import logging
+from typing import Tuple
+
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import QAbstractItemView
+
+from . import config as cfg
+from . import gui_utilities, observations_list, project_functions
+from . import utilities as util
+
+
+def select_observations2(self, mode: str, windows_title: str = "") -> Tuple[str, list]:
+    """
+    allow user to select observations
+    mode: accepted values: OPEN, EDIT, SINGLE, MULTIPLE, SELECT1
+
+    Args:
+        pj (dict): BORIS project dictionary
+        mode (str): mode for selection: OPEN, EDIT, SINGLE, MULTIPLE, SELECT1
+        windows_title (str): title for windows
+
+    Returns:
+        str: selected mode: OPEN, EDIT, VIEW
+        list: list of selected observations
+    """
+
+    pj = self.pj
+
+    fields_list = ["id", "date", "description", "subjects", "observation duration", "exhaustivity %", "media"]
+    indep_var_header, column_type = [], [cfg.TEXT, cfg.TEXT, cfg.TEXT, cfg.TEXT, cfg.NUMERIC, cfg.NUMERIC, cfg.TEXT]
+
+    if cfg.INDEPENDENT_VARIABLES in pj:
+        for idx in util.sorted_keys(pj[cfg.INDEPENDENT_VARIABLES]):
+            indep_var_header.append(pj[cfg.INDEPENDENT_VARIABLES][idx]["label"])
+            column_type.append(pj[cfg.INDEPENDENT_VARIABLES][idx]["type"])
+
+    state_events_list = util.state_behavior_codes(pj[cfg.ETHOGRAM])
+
+    data: list = []
+    not_paired: list = []
+
+    # check if observations changed
+    if hash(str(self.pj[cfg.OBSERVATIONS])) != self.mem_hash_obs:
+        logging.debug("observations changed")
+
+        for obs in sorted(list(pj[cfg.OBSERVATIONS].keys())):
+            date = pj[cfg.OBSERVATIONS][obs]["date"].replace("T", " ")
+            descr = util.eol2space(pj[cfg.OBSERVATIONS][obs][cfg.DESCRIPTION])
+
+            # subjects
+            observed_subjects = [cfg.NO_FOCAL_SUBJECT if x == "" else x for x in project_functions.extract_observed_subjects(pj, [obs])]
+
+            subjectsList = ", ".join(observed_subjects)
+
+            # observed time interval
+            interval = project_functions.observed_interval(pj[cfg.OBSERVATIONS][obs])
+            observed_interval_str = str(round(interval[1] - interval[0], 3))
+
+            # media
+            media: str = ""
+            if pj[cfg.OBSERVATIONS][obs][cfg.TYPE] == cfg.MEDIA:
+                media_list: list = []
+                if pj[cfg.OBSERVATIONS][obs][cfg.FILE]:
+                    for player in sorted(pj[cfg.OBSERVATIONS][obs][cfg.FILE].keys()):
+                        for media in pj[cfg.OBSERVATIONS][obs][cfg.FILE][player]:
+                            media_list.append(f"#{player}: {media}")
+
+                if len(media_list) > 8:
+                    media = " ".join(media_list)
+                else:
+                    media = "\n".join(media_list)
+
+            if pj[cfg.OBSERVATIONS][obs][cfg.TYPE] == cfg.LIVE:
+                media = cfg.LIVE
+
+            if pj[cfg.OBSERVATIONS][obs][cfg.TYPE] == cfg.IMAGES:
+                dir_list: list = []
+                for dir_path in pj[cfg.OBSERVATIONS][obs].get(cfg.DIRECTORIES_LIST, []):
+                    dir_list.append(dir_path)
+                media = "; ".join(dir_list)
+
+            # independent variables
+            indepvar: list = []
+            if cfg.INDEPENDENT_VARIABLES in pj[cfg.OBSERVATIONS][obs]:
+                for var_label in indep_var_header:
+                    if var_label in pj[cfg.OBSERVATIONS][obs][cfg.INDEPENDENT_VARIABLES]:
+                        indepvar.append(pj[cfg.OBSERVATIONS][obs][cfg.INDEPENDENT_VARIABLES][var_label])
+                    else:
+                        indepvar.append("")
+
+            # check unpaired events
+            ok, _ = project_functions.check_state_events_obs(obs, pj[cfg.ETHOGRAM], pj[cfg.OBSERVATIONS][obs], cfg.HHMMSS)
+            if not ok:
+                not_paired.append(obs)
+
+            # exhaustivity
+            if pj[cfg.OBSERVATIONS][obs][cfg.TYPE] in (cfg.MEDIA, cfg.LIVE):
+                # check exhaustivity of observation
+                exhaustivity = project_functions.check_observation_exhaustivity(pj[cfg.OBSERVATIONS][obs][cfg.EVENTS], state_events_list)
+            elif pj[cfg.OBSERVATIONS][obs][cfg.TYPE] == cfg.IMAGES:
+                exhaustivity = project_functions.check_observation_exhaustivity_pictures(pj[cfg.OBSERVATIONS][obs])
+
+            data.append([obs, date, descr, subjectsList, observed_interval_str, str(exhaustivity), media] + indepvar)
+
+        obsList = observations_list.observationsList_widget(
+            data, header=fields_list + indep_var_header, column_type=column_type, not_paired=not_paired
+        )
+        self.data = data
+        self.not_paired = not_paired
+        self.mem_hash_obs = hash(str(self.pj[cfg.OBSERVATIONS]))
+
+    else:
+        obsList = observations_list.observationsList_widget(
+            self.data, header=fields_list + indep_var_header, column_type=column_type, not_paired=self.not_paired
+        )
+
+    if windows_title:
+        obsList.setWindowTitle(windows_title)
+
+    obsList.pbOpen.setVisible(False)
+    obsList.pbView.setVisible(False)
+    obsList.pbEdit.setVisible(False)
+    obsList.pbOk.setVisible(False)
+    obsList.pbSelectAll.setVisible(False)
+    obsList.pbUnSelectAll.setVisible(False)
+    obsList.mode = mode
+
+    if mode == cfg.OPEN:
+        obsList.view.setSelectionMode(QAbstractItemView.SingleSelection)
+        obsList.pbOpen.setVisible(True)
+
+    if mode == cfg.VIEW:
+        obsList.view.setSelectionMode(QAbstractItemView.SingleSelection)
+        obsList.pbView.setVisible(True)
+
+    if mode == cfg.EDIT:
+        obsList.view.setSelectionMode(QAbstractItemView.SingleSelection)
+        obsList.pbEdit.setVisible(True)
+
+    if mode == cfg.SINGLE:
+        obsList.view.setSelectionMode(QAbstractItemView.SingleSelection)
+        obsList.pbOpen.setVisible(True)
+        obsList.pbView.setVisible(True)
+        obsList.pbEdit.setVisible(True)
+
+    if mode == cfg.MULTIPLE:
+        obsList.view.setSelectionMode(QAbstractItemView.MultiSelection)
+        obsList.pbOk.setVisible(True)
+        obsList.pbSelectAll.setVisible(True)
+        obsList.pbUnSelectAll.setVisible(True)
+
+    if mode == cfg.SELECT1:
+        obsList.view.setSelectionMode(QAbstractItemView.SingleSelection)
+        obsList.pbOk.setVisible(True)
+
+    # restore window geometry
+    gui_utilities.restore_geometry(obsList, "observations list", (900, 600))
+
+    obsList.view.sortItems(0, Qt.AscendingOrder)
+    for row in range(obsList.view.rowCount()):
+        obsList.view.resizeRowToContents(row)
+
+    selected_observations = []
+
+    result = obsList.exec_()
+
+    # saving window geometry in ini file
+    gui_utilities.save_geometry(obsList, "observations list")
+
+    if result:
+        if obsList.view.selectedIndexes():
+            for idx in obsList.view.selectedIndexes():
+                if idx.column() == 0:  # first column
+                    selected_observations.append(idx.data())
+
+    if result == 0:  # cancel
+        resultStr = ""
+    if result == 1:  # select
+        resultStr = "ok"
+    if result == 2:  # open
+        resultStr = cfg.OPEN
+    if result == 3:  # edit
+        resultStr = cfg.EDIT
+    if result == 4:  # view
+        resultStr = cfg.VIEW
+
+    return resultStr, selected_observations