pyclickimage 2.0.4__tar.gz → 2.2.0__tar.gz

{pyclickimage-2.0.4 → pyclickimage-2.2.0}/.bumpver.toml

@@ -1,5 +1,5 @@
 [bumpver]
-current_version = "2.0.4"
+current_version = "2.2.0"
 version_pattern = "MAJOR.MINOR.PATCH"
 default_level = "patch"
 

{pyclickimage-2.0.4 → pyclickimage-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyclickimage
-Version: 2.0.4
+Version: 2.2.0
 Summary: Python library to select points on a image [pyqt5 GUI]
 Author-email: Artezaru <artezaru.github@proton.me>
 License:                     GNU GENERAL PUBLIC LICENSE

{pyclickimage-2.0.4 → pyclickimage-2.2.0}/pyclickimage/__version__.py

@@ -16,4 +16,4 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-__version__ = "2.0.4"
+__version__ = "2.2.0"

{pyclickimage-2.0.4 → pyclickimage-2.2.0}/pyclickimage/click_image_app.py

@@ -62,7 +62,7 @@ class ClickImageApp(QtWidgets.QMainWindow):
         # Core components
         # -------------------------
         self.click_manager = ClickManager(precision_mode="float")
-        self.viewer = ImageViewer()
+        self.viewer = ImageViewer(half_shift=True)
 
         # -------------------------
         # Logging
@@ -184,6 +184,20 @@ class ClickImageApp(QtWidgets.QMainWindow):
         self.precision_checkbox.setShortcut("Ctrl+I")
         side.addWidget(self.precision_checkbox)
 
+        self.half_shift_checkbox = QtWidgets.QCheckBox(
+            "Half-Shift: (0,0) on the pixel center."
+        )
+        self.half_shift_checkbox.setChecked(True)
+        self.half_shift_checkbox.stateChanged.connect(self.on_half_shift_changed)
+        side.addWidget(self.half_shift_checkbox)
+
+        self.display_clicks_checkbox = QtWidgets.QCheckBox("Display clicks")
+        self.display_clicks_checkbox.setChecked(True)
+        self.display_clicks_checkbox.stateChanged.connect(
+            self.on_display_clicks_changed
+        )
+        side.addWidget(self.display_clicks_checkbox)
+
         # ============================================================
         # Group selector
         # ============================================================
@@ -372,6 +386,10 @@ class ClickImageApp(QtWidgets.QMainWindow):
 
         toolbar.addSeparator()
 
+        toolbar.addAction("Clear Logs", self.clear_logs)
+
+        toolbar.addSeparator()
+
     # ============================================================
     # Precision mode
     # ============================================================
@@ -385,6 +403,44 @@ class ClickImageApp(QtWidgets.QMainWindow):
         self._append_log(f"Precision mode: {'INT' if INT else 'FLOAT'}")
         self.update()
 
+    def on_half_shift_changed(self, state):
+        r"""
+        Toggle half-shift mode.
+        """
+
+        half_shift = state == QtCore.Qt.Checked
+
+        if self.click_manager.n_clicks > 0:
+
+            msg = QtWidgets.QMessageBox(self)
+            msg.setWindowTitle("Existing clicks detected")
+            msg.setText(
+                f"Do you want to shift all previous clicked points by 0.5 to match the new coordinates system ?"
+            )
+            msg.setInformativeText("No = keep clicks\nYes = shift clicks")
+            msg.setStandardButtons(QtWidgets.QMessageBox.No | QtWidgets.QMessageBox.Yes)
+            msg.setDefaultButton(QtWidgets.QMessageBox.Yes)
+
+            choice = msg.exec_()
+
+            if choice == QtWidgets.QMessageBox.Yes:
+                if half_shift:
+                    self.click_manager.to_half_shift_on()
+                else:
+                    self.click_manager.to_half_shift_off()
+
+        self.viewer.half_shift = half_shift
+        self._append_log(f"Half-Shift mode: {half_shift}")
+        self.update()
+
+    def on_display_clicks_changed(self, state):
+        r"""
+        Toggle dispaly clicks.
+        """
+        DISPLAY = state == QtCore.Qt.Checked
+        self._append_log(f"Display clicks: {DISPLAY}")
+        self.update()
+
     # ============================================================
     # Image
     # ============================================================
@@ -393,7 +449,6 @@ class ClickImageApp(QtWidgets.QMainWindow):
         r"""
         Set image to display.
         """
-
         if image is None:
             image = np.zeros((512, 512, 3), dtype=np.uint8)
             self._is_empty_image = True
@@ -530,10 +585,12 @@ class ClickImageApp(QtWidgets.QMainWindow):
 
         pts = self.click_manager.extract_group()
 
-        for x, y in pts:
-            if x is None or y is None:
-                continue
-            self.viewer.add_marker((x, y), self.marker_color, self.marker_size)
+        DISPLAY = self.display_clicks_checkbox.isChecked()
+        if DISPLAY:
+            for x, y in pts:
+                if x is None or y is None:
+                    continue
+                self.viewer.add_marker((x, y), self.marker_color, self.marker_size)
 
     def update_table(self):
         r"""
@@ -878,6 +935,12 @@ class ClickImageApp(QtWidgets.QMainWindow):
         """
         self.log_text_edit.append(msg)
 
+    def clear_logs(self):
+        r"""
+        Clear log message.
+        """
+        self.log_text_edit.clear()
+
     # ============================================================
     # Close event
     # ============================================================

{pyclickimage-2.0.4 → pyclickimage-2.2.0}/pyclickimage/click_manager.py

@@ -56,7 +56,6 @@ class ClickManager:
     # =========================================================
     # PRECISION MODE
     # =========================================================
-
     @property
     def precision_mode(self) -> str:
         r"""
@@ -87,7 +86,7 @@ class ClickManager:
         if mode not in ("float", "int"):
             raise ValueError("precision_mode must be 'float' or 'int'")
         self._precision_mode = mode
-        
+
     @property
     def use_int_precision(self) -> bool:
         r"""
@@ -95,7 +94,6 @@ class ClickManager:
         """
         return self._precision_mode == "int"
 
-
     @use_int_precision.setter
     def use_int_precision(self, value: bool) -> None:
         r"""
@@ -103,7 +101,6 @@ class ClickManager:
         """
         self._precision_mode = "int" if value else "float"
 
-
     @property
     def use_float_precision(self) -> bool:
         r"""
@@ -111,7 +108,6 @@ class ClickManager:
         """
         return self._precision_mode == "float"
 
-
     @use_float_precision.setter
     def use_float_precision(self, value: bool) -> None:
         r"""
@@ -217,6 +213,12 @@ class ClickManager:
     # =========================================================
     # CLICKS
     # =========================================================
+    @property
+    def n_clicks(self) -> int:
+        r"""
+        Return the number of clicks
+        """
+        return sum(len(g) for _, g in self.groups.items())
 
     def add_click(
         self, x: Optional[Number], y: Optional[Number], group_name: Optional[str] = None
@@ -243,6 +245,36 @@ class ClickManager:
 
         self.groups[group_name].append((x, y))
 
+    def to_half_shift_on(self):
+        r"""
+        Shift all points by -0.5 to use pixel-centered coordinates.
+
+        Point (a, b) -> (a - 0.5, b - 0.5)
+        """
+        for group_name, points in self.groups.items():
+            self.groups[group_name] = [
+                (
+                    (x - 0.5) if x is not None else None,
+                    (y - 0.5) if y is not None else None,
+                )
+                for (x, y) in points
+            ]
+
+    def to_half_shift_off(self):
+        r"""
+        Reverse the half-pixel shift.
+
+        Point (a, b) -> (a + 0.5, b + 0.5)
+        """
+        for group_name, points in self.groups.items():
+            self.groups[group_name] = [
+                (
+                    (x + 0.5) if x is not None else None,
+                    (y + 0.5) if y is not None else None,
+                )
+                for (x, y) in points
+            ]
+
     def extract_group(self, group_name: Optional[str] = None) -> List[Point]:
         r"""
         Extracts the clicks for the specified group.
@@ -380,7 +412,7 @@ class ClickManager:
             next(reader)
 
             for group, _, x, y in reader:
-                
+
                 instance.add_group(group)
 
                 x_val = float(x) if x != "" else None

{pyclickimage-2.0.4 → pyclickimage-2.2.0}/pyclickimage/image_viewer.py

@@ -29,7 +29,14 @@ class ImageViewer(QtWidgets.QGraphicsView):
     - zoom with mouse wheel
     - precise click detection (drag-safe)
     - marker system for annotation
+
+    half-shift :
+
+    - True = (0,0) on the center of the first pixel.
+    - False = (0,0) on the corner of the first pixel.
+
     """
+
     left_click_signal = QtCore.pyqtSignal(float, float)
     right_click_signal = QtCore.pyqtSignal(float, float)
 
@@ -37,7 +44,7 @@ class ImageViewer(QtWidgets.QGraphicsView):
     # INIT
     # ======================================================================
 
-    def __init__(self, parent=None):
+    def __init__(self, parent=None, half_shift=True):
         r"""
         Initialize the ImageViewer.
 
@@ -92,6 +99,7 @@ class ImageViewer(QtWidgets.QGraphicsView):
             Tuple[QtWidgets.QGraphicsLineItem, QtWidgets.QGraphicsLineItem]
         ] = []
         self.auto_marker = True
+        self.half_shift = bool(half_shift)
 
     # ======================================================================
     # IMAGE LOADING
@@ -141,7 +149,7 @@ class ImageViewer(QtWidgets.QGraphicsView):
         # IMPORTANT: reset markers if needed
         self._zoom = 0
         self._markers = []
-        
+
     # ======================================================================
     # CROSSHAIR MANAGEMENT
     # ======================================================================
@@ -150,8 +158,7 @@ class ImageViewer(QtWidgets.QGraphicsView):
         Return current crosshair color.
         """
         return self._crosshair_color
-        
-        
+
     def set_crosshair_color(self, color):
         r"""
         Set the crosshair color
@@ -163,7 +170,7 @@ class ImageViewer(QtWidgets.QGraphicsView):
 
         self._cross_h.setPen(pen)
         self._cross_v.setPen(pen)
-        
+
     def _create_crosshair(self):
         r"""
         Create the crosshair
@@ -212,11 +219,15 @@ class ImageViewer(QtWidgets.QGraphicsView):
 
         self._cross_v.setLine(scene_pos.x(), rect.top(), scene_pos.x(), rect.bottom())
 
+        x, y = scene_pos.x(), scene_pos.y()
+        if self.half_shift:
+            x = x - 0.5
+            y = y - 0.5
+
         self._coord_label.show()
-        self._coord_label.setText(f"X={scene_pos.x():.3f}  Y={scene_pos.y():.3f}")
+        self._coord_label.setText(f"X={x:.3f}  Y={y:.3f}")
         self._coord_label.adjustSize()
 
-
     # ======================================================================
     # ZOOM
     # ======================================================================
@@ -317,6 +328,10 @@ class ImageViewer(QtWidgets.QGraphicsView):
 
         x, y = scene_pos.x(), scene_pos.y()
 
+        if self.half_shift:
+            x = x - 0.5
+            y = y - 0.5
+
         if event.button() == QtCore.Qt.LeftButton:
             self.left_click_signal.emit(x, y)
 
@@ -350,6 +365,10 @@ class ImageViewer(QtWidgets.QGraphicsView):
         """
         x, y = center
 
+        if self.half_shift:
+            x = x + 0.5
+            y = y + 0.5
+
         pen = QtGui.QPen(color)
         pen.setWidthF(0)
 

{pyclickimage-2.0.4 → pyclickimage-2.2.0}/pyclickimage.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyclickimage
-Version: 2.0.4
+Version: 2.2.0
 Summary: Python library to select points on a image [pyqt5 GUI]
 Author-email: Artezaru <artezaru.github@proton.me>
 License:                     GNU GENERAL PUBLIC LICENSE