Add CamerasTable to SessionsDock

sleap/gui/app.py

@@ -145,6 +145,7 @@ def __init__(
         self.state["labeled_frame"] = None
         self.state["last_interacted_frame"] = None
         self.state["filename"] = None
+        self.state["session"] = None
         self.state["show non-visible nodes"] = prefs["show non-visible nodes"]
         self.state["show instances"] = True
         self.state["show labels"] = True
@@ -1094,6 +1095,7 @@ def _update_gui_state(self):
         has_selected_edge = self.state["selected_edge"] is not None
         has_selected_video = self.state["selected_video"] is not None
         has_video = self.state["video"] is not None
+        has_selected_camcorder = self.state["selected_camera"] is not None
 
         has_frame_range = bool(self.state["has_frame_range"])
         has_unsaved_changes = bool(self.state["has_changes"])
@@ -1148,6 +1150,7 @@ def _update_gui_state(self):
         self._buttons["show video"].setEnabled(has_selected_video)
         self._buttons["remove video"].setEnabled(has_video)
         self._buttons["delete instance"].setEnabled(has_selected_instance)
+        self._buttons["unlink video"].setEnabled(has_selected_camcorder)
         self.suggestions_dock.suggestions_form_widget.buttons[
             "generate_button"
         ].setEnabled(has_videos)
@@ -1236,6 +1239,11 @@ def _has_topic(topic_list):
         if _has_topic([UpdateTopic.frame, UpdateTopic.project_instances]):
             self.state["last_interacted_frame"] = self.state["labeled_frame"]
 
+        if _has_topic([UpdateTopic.sessions]):
+            self.sessions_dock.camera_table.model().items = self.state[
+                "session"  # TODO(LM): Use "selected_session" here
+            ]
+
     def plotFrame(self, *args, **kwargs):
         """Plots (or replots) current frame."""
         if self.state["video"] is None:

sleap/gui/commands.py

@@ -82,6 +82,7 @@ class UpdateTopic(Enum):
     frame = 8
     project = 9
     project_instances = 10
+    sessions = 11
 
 
 class AppCommand:
@@ -655,6 +656,10 @@ def openPrereleaseVersion(self):
         """Open the current prerelease version."""
         self.execute(OpenPrereleaseVersion)
 
+    def unlink_video_from_camera(self):
+        """Unlinks video from a camera"""
+        self.execute(UnlinkVideo)
+
 
 # File Commands
 
@@ -697,6 +702,8 @@ def do_action(context: "CommandContext", params: dict):
         if len(labels.videos):
             context.state["video"] = labels.videos[0]
 
+        context.state["session"] = labels.sessions[0] if len(labels.sessions) else None
+
         context.state["project_loaded"] = True
         context.state["has_changes"] = params.get("changed_on_load", False) or (
             filename is None
@@ -3901,3 +3908,21 @@ def copy_to_clipboard(text: str):
     clipboard = QtWidgets.QApplication.clipboard()
     clipboard.clear(mode=clipboard.Clipboard)
     clipboard.setText(text, mode=clipboard.Clipboard)
+
+
+class UnlinkVideo(EditCommand):
+    topics = [UpdateTopic.sessions]
+
+    @staticmethod
+    def do_action(context: CommandContext, params: dict):
+        camcorder = context.state["selected_camera"]
+        # TODO(LM): replace with state["selected_session"]
+        recording_session = context.state["session"]
+
+        video = camcorder.get_video(recording_session)
+
+        if video is not None and recording_session is not None:
+            recording_session.remove_video(video)
+
+        # Reset the selected camera
+        context.state["selected_camera"] = None

sleap/gui/dataviews.py

@@ -30,6 +30,7 @@
 from sleap.io.dataset import Labels
 from sleap.instance import LabeledFrame, Instance
 from sleap.skeleton import Skeleton
+from sleap.io.cameras import Camcorder, RecordingSession
 
 
 class GenericTableModel(QtCore.QAbstractTableModel):
@@ -652,3 +653,22 @@ def columnCount(self, parent):
     def flags(self, index: QtCore.QModelIndex):
         """Overrides Qt method, returns flags (editable etc)."""
         return QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable
+
+
+class CamerasTableModel(GenericTableModel):
+    """Table model for unlinking `Camcorder`s and `Video`s within a `RecordingSession`.
+
+    Args:
+        obj: 'RecordingSession' which has information of cameras
+              and paired video
+    """
+
+    properties = ("camera", "video")
+
+    def object_to_items(self, obj: RecordingSession):
+        return obj.camera_cluster.cameras
+
+    def item_to_data(self, obj: RecordingSession, item: Camcorder):
+
+        video = obj.get_video(item)
+        return {"camera": item.name, "video": video.filename if video else ""}

sleap/gui/widgets/docks.py

@@ -31,6 +31,7 @@
     SkeletonNodesTableModel,
     SuggestionsTableModel,
     VideosTableModel,
+    CamerasTableModel,
 )
 from sleap.gui.dialogs.formbuilder import YamlFormWidget
 from sleap.gui.widgets.views import CollapsibleWidget
@@ -574,9 +575,20 @@ def create_table_edit_buttons(self) -> QWidget:
 
 class SessionsDock(DockWidget):
     def __init__(self, main_window: Optional[QMainWindow]):
-        super().__init__(name="Sessions", main_window=main_window, model_type=None)
+        self.camera_model_type = CamerasTableModel
+        super().__init__(name="Sessions", main_window=main_window, model_type=[self.camera_model_type])
+
 
     def lay_everything_out(self) -> None:
+        if self.table is None:
+            self.create_tables()
+
+
+        self.wgt_layout.addWidget(self.camera_table)
+
+        video_unlink_button = self.create_video_unlink_button()
+        self.wgt_layout.addWidget(video_unlink_button)
+
         triangulation_options = self.create_triangulation_options()
         self.wgt_layout.addWidget(triangulation_options)
 
@@ -601,3 +613,34 @@ def create_triangulation_options(self) -> QWidget:
         hbw = QWidget()
         hbw.setLayout(hb)
         return hbw
+
+    def create_models(self) -> GenericTableModel:
+        main_window = self.main_window
+        self.camera_model = self.camera_model_type(
+            items=main_window.state["selected_session"], context=main_window.commands
+        )
+
+        return {"camera_model": self.camera_model}
+
+    def create_tables(self) -> GenericTableView:
+        if self.model is None:
+            self.create_models()
+
+        main_window = self.main_window
+        self.camera_table = GenericTableView(
+            state=main_window.state,
+            row_name="camera",
+            model=self.camera_model,
+        )
+
+        return {"camera_table": self.camera_table}
+
+    def create_video_unlink_button(self) -> QWidget:
+        main_window = self.main_window
+
+        hb = QHBoxLayout()
+        self.add_button(hb, "Unlink Video", main_window.commands.unlink_video_from_camera)
+
+        hbw = QWidget()
+        hbw.setLayout(hb)
+        return hbw

sleap/io/cameras.py

@@ -42,7 +42,7 @@ def sessions(self) -> List["RecordingSession"]:
 
     def get_video(self, session: "RecordingSession") -> Optional[Video]:
         if session not in self._video_by_session:
-            logger.warning(f"{session} not found in {self}.")
+            logger.debug(f"{session} not found in {self}.")
             return None
         return self._video_by_session[session]
 
@@ -462,7 +462,7 @@ def get_video(self, camcorder: Camcorder) -> Optional[Video]:
             )
 
         if camcorder not in self._video_by_camcorder:
-            logger.warning(
+            logger.debug(
                 f"Camcorder {camcorder.name} is not linked to a video in this "
                 f"RecordingSession."
             )

tests/gui/test_dataviews.py

@@ -2,6 +2,7 @@
 import pytestqt
 
 from sleap.gui.dataviews import *
+from sleap.io.cameras import RecordingSession
 
 
 def test_skeleton_nodes(qtbot, centered_pair_predictions):
@@ -84,3 +85,57 @@ def test_table_sort_string(qtbot):
     # Make sure we can sort with both numbers and strings (i.e., "")
     table.model().sort(0)
     table.model().sort(1)
+
+
+def test_camera_table(qtbot, multiview_min_session_labels):
+
+    session = multiview_min_session_labels.sessions[0]
+    camcorders = session.camera_cluster.cameras
+
+    table_model = CamerasTableModel(items=session)
+    num_rows = table_model.rowCount()
+
+    assert table_model.columnCount() == 2
+    assert num_rows == len(camcorders)
+
+    table = GenericTableView(
+        row_name="camera",
+        model=table_model,
+    )
+
+    # Test if all comcorders are presented in the correct row
+    for i in range(num_rows):
+        table.selectRow(i)
+
+        # Check first column
+        assert table.getSelectedRowItem() == camcorders[i]
+        assert table.model().data(table.currentIndex()) == camcorders[i].name
+
+        # Check second column
+        index = table.model().index(i, 1)
+        linked_video_filename = camcorders[i].get_video(session).filename
+        assert table.model().data(index) == linked_video_filename
+
+    # Test if a comcorder change is reflected
+    idxs_to_remove = [1, 2, 7]
+    for idx in idxs_to_remove:
+        multiview_min_session_labels.sessions[0].remove_video(
+            camcorders[idx].get_video(multiview_min_session_labels.sessions[0])
+        )
+    table.model().items = session
+
+    for i in range(num_rows):
+        table.selectRow(i)
+
+        # Check first column
+        assert table.getSelectedRowItem() == camcorders[i]
+        assert table.model().data(table.currentIndex()) == camcorders[i].name
+
+        # Check second column
+        index = table.model().index(i, 1)
+        linked_video = camcorders[i].get_video(session)
+        if i in idxs_to_remove:
+            assert table.model().data(index) == ""
+        else:
+            linked_video_filename = linked_video.filename
+            assert table.model().data(index) == linked_video_filename

tests/gui/widgets/test_docks.py

@@ -4,7 +4,7 @@
 import pytest
 from sleap import Labels, Video
 from sleap.gui.app import MainWindow
-from sleap.gui.commands import OpenSkeleton
+from sleap.gui.commands import OpenSkeleton, UnlinkVideo
 from sleap.gui.widgets.docks import (
     InstancesDock,
     SuggestionsDock,
@@ -107,3 +107,51 @@ def test_instances_dock(qtbot):
     assert dock.name == "Instances"
     assert dock.main_window is main_window
     assert dock.wgt_layout is dock.widget().layout()
+
+
+def test_sessions_dock_cameras_table(qtbot, multiview_min_session_labels):
+    labels = multiview_min_session_labels
+    session = labels.sessions[0]
+    camcorders = session.camera_cluster.cameras
+    main_window = MainWindow(labels=labels)
+    assert main_window.state["session"] == session
+
+    dock = main_window.sessions_dock
+    table = dock.camera_table
+
+    # Testing if cameras_table is loaded correctly
+
+    # Test if all comcorders are presented in the correct row
+    for i, cam in enumerate(camcorders):
+        table.selectRow(i)
+
+        # Check first column
+        assert table.getSelectedRowItem() == cam
+        assert table.model().data(table.currentIndex()) == cam.name
+
+        # Check second column
+        index = table.model().index(i, 1)
+        linked_video_filename = cam.get_video(session).filename
+        assert table.model().data(index) == linked_video_filename
+
+    # Test if a comcorder change is reflected
+    idxs_to_remove = [1, 2, 7]
+    for idx in idxs_to_remove:
+        main_window.state["selected_camera"] = camcorders[idx]
+        main_window._buttons["unlink video"].click()
+
+    for i, cam in enumerate(camcorders):
+        table.selectRow(i)
+
+        # Check first column
+        assert table.getSelectedRowItem() == camcorders[i]
+        assert table.model().data(table.currentIndex()) == camcorders[i].name
+
+        # Check second column
+        index = table.model().index(i, 1)
+        linked_video = camcorders[i].get_video(session)
+        if i in idxs_to_remove:
+            assert table.model().data(index) == ""
+        else:
+            linked_video_filename = linked_video.filename
+            assert table.model().data(index) == linked_video_filename