Auto lock keypoint selection when in loop mode

Author: jeylau

MANIFEST.in

@@ -1,6 +1,5 @@
 include LICENSE
 include README.md
-include src/napari_deeplabcut/assets/*.svg
 
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]

src/napari_deeplabcut/_widgets.py

@@ -18,8 +18,8 @@
 from napari.layers.utils.layer_utils import _features_to_properties
 from napari.utils.events import Event
 from napari.utils.history import get_save_history, update_save_history
-from qtpy.QtCore import Qt, QTimer, Signal, QSize, QPoint, QSettings
-from qtpy.QtGui import QPainter, QIcon, QAction, QCursor
+from qtpy.QtCore import Qt, QTimer, Signal, QPoint, QSettings
+from qtpy.QtGui import QPainter, QAction, QCursor
 from qtpy.QtWidgets import (
     QButtonGroup,
     QCheckBox,
@@ -41,8 +41,6 @@
     QWidget,
 )
 
-ICON_FOLDER = os.path.join(os.path.dirname(__file__), "assets")
-
 from napari_deeplabcut import keypoints
 from napari_deeplabcut._reader import _load_config
 from napari_deeplabcut._writer import _write_config, _write_image, _form_df
@@ -764,8 +762,15 @@ def label_mode(self):
     def label_mode(self, mode: Union[str, keypoints.LabelMode]):
         self._label_mode = keypoints.LabelMode(mode)
         self.viewer.status = self.label_mode
+        mode_ = str(mode)
+        if mode_ == "loop":
+            for menu in self._menus:
+                menu._locked = True
+        else:
+            for menu in self._menus:
+                menu._locked = False
         for btn in self._radio_group.buttons():
-            if btn.text() == str(mode):
+            if btn.text() == mode_:
                 btn.setChecked(True)
                 break
 
@@ -827,11 +832,6 @@ def __init__(
         layout2 = QVBoxLayout()
         for menu in self.menus.values():
             layout2.addWidget(menu)
-        self.lock_button = QPushButton("Lock selection")
-        self.lock_button.setIcon(QIcon(os.path.join(ICON_FOLDER, "unlock.svg")))
-        self.lock_button.setIconSize(QSize(24, 24))
-        self.lock_button.clicked.connect(self._lock_current_keypoint)
-        layout2.addWidget(self.lock_button)
         group_box.setLayout(layout2)
         layout1.addWidget(group_box)
         self.setLayout(layout1)
@@ -861,15 +861,6 @@ def _update_items(self):
             self.menus["id"].update_items(list(self.id2label))
         self.menus["label"].update_items(self.id2label[id_])
 
-    def _lock_current_keypoint(self):
-        self._locked = not self._locked
-        if self._locked:
-            self.lock_button.setText("Unlock selection")
-            self.lock_button.setIcon(QIcon(os.path.join(ICON_FOLDER, "lock.svg")))
-        else:
-            self.lock_button.setText("Lock selection")
-            self.lock_button.setIcon(QIcon(os.path.join(ICON_FOLDER, "unlock.svg")))
-
     def update_menus(self, event):
         keypoint = self.store.current_keypoint
         for attr, menu in self.menus.items():
@@ -886,7 +877,7 @@ def refresh_label_menu(self, text: str):
 
     def smart_reset(self, event):
         """Set current keypoint to the first unlabeled one."""
-        if self._locked:
+        if self._locked:  # The currently selected point is not updated
             return
         unannotated = ""
         already_annotated = self.store.annotated_keypoints

src/napari_deeplabcut/assets/lock.svg

@@ -41,11 +41,8 @@ class LabelMode(CycleEnum):
         clicking to add an already annotated point has no effect.
     QUICK: similar to SEQUENTIAL, but trying to add an already
         annotated point actually moves it to the cursor location.
-    LOOP: the first point is placed frame by frame, then it wraps
-        to the next label at the end and restart from frame 1, etc.
-        Unless the keypoint selection is locked, the dropdown menu is
-        automatically set to the first unlabeled keypoint of
-        the current frame.
+    LOOP: the currently selected point is placed frame after frame,
+        before wrapping at the end to frame 1, etc.
     """
 
     SEQUENTIAL = auto()
@@ -63,11 +60,8 @@ def default(cls):
     "clicking to add an already annotated point has no effect.",
     "QUICK": "Similar to SEQUENTIAL, but trying to add an already\n"
     "annotated point actually moves it to the cursor location.",
-    "LOOP": "The first point is placed frame by frame, then it wraps\n"
-    "to the next label at the end and restart from frame 1, etc.\n"
-    "Unless the keypoint selection is locked, the dropdown menu is\n"
-    "automatically set to the first unlabeled keypoint of\n"
-    "the current frame.",
+    "LOOP": "The currently selected point is placed frame after frame,\n"
+    "before wrapping at the end to frame 1, etc.",
 }