lazylabel-gui 1.0.0__tar.gz

lazylabel_gui-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Deniz N. Cakan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lazylabel_gui-1.0.0/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: lazylabel-gui
+Version: 1.0.0
+Summary: An image segmentation GUI for generating mask tensors.
+Author-email: "Deniz N. Cakan" <deniz.n.cakan@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Deniz N. Cakan
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/dnzckn/lazylabel
+Project-URL: Bug Tracker, https://github.com/dnzckn/lazylabel/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Environment :: X11 Applications :: Qt
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyQt6>=6.9.0
+Requires-Dist: pyqtdarktheme==2.1.0
+Requires-Dist: torch>=2.7.1
+Requires-Dist: torchvision>=0.22.1
+Requires-Dist: segment-anything==1.0
+Requires-Dist: numpy>=2.3.0
+Requires-Dist: opencv-python>=4.11.0.86
+Requires-Dist: scipy>=1.15.3
+Requires-Dist: requests>=2.32.4
+Requires-Dist: tqdm>=4.67.1
+Dynamic: license-file
+
+# <img src="https://raw.githubusercontent.com/dnzckn/LazyLabel/main/src/lazylabel/demo_pictures/logo2.png" alt="LazyLabel Logo" style="height:60px; vertical-align:middle;" /> <img src="https://raw.githubusercontent.com/dnzckn/LazyLabel/main/src/lazylabel/demo_pictures/logo_black.png" alt="LazyLabel Cursive" style="height:60px; vertical-align:middle;" />
+LazyLabel is an intuitive, AI-assisted image segmentation tool. It uses Meta's Segment Anything Model (SAM) for quick, precise mask generation, alongside advanced polygon editing for fine-tuned control. Outputs are saved in a clean, one-hot encoded format for easy machine learning integration.
+
+Inspired by [LabelMe](https://github.com/wkentaro/labelme?tab=readme-ov-file#installation) and [Segment-Anything-UI](https://github.com/branislavhesko/segment-anything-ui/tree/main).
+
+![LazyLabel Screenshot](https://raw.githubusercontent.com/dnzckn/LazyLabel/main/src/lazylabel/demo_pictures/gui.PNG)
+
+---
+
+## ✨ Core Features
+
+* **AI-Powered Segmentation**: Generate masks with simple left-click (positive) and right-click (negative) interactions.
+* **Vector Polygon Tool**: Full control to draw, edit, and reshape polygons. Drag vertices or move entire shapes.
+* **Advanced Class Management**: Assign multiple segments to a single class ID for organized labeling.
+* **Intuitive Editing & Refinement**: Select, merge, and re-order segments.
+* **Interactive UI**: Color-coded segments, sortable lists, and hover highlighting.
+* **Smart I/O**: Loads existing `.npz` masks; saves work as clean, one-hot encoded outputs.
+
+---
+
+## 🚀 Getting Started
+
+### Prerequisites
+Ensure you have **Python 3.10** or newer.
+
+### Installation
+
+#### For Users (via PyPI)
+1.  Install LazyLabel directly:
+    ```bash
+    pip install lazylabel-gui
+    ```
+2.  Run the application:
+    ```bash
+    lazylabel-gui
+    ```
+
+#### For Developers (from Source)
+1.  Clone the repository:
+    ```bash
+    git clone [https://github.com/dnzckn/LazyLabel.git](https://github.com/dnzckn/LazyLabel.git)
+    cd LazyLabel
+    ```
+2.  Install in editable mode, which links the installed package to your source directory:
+    ```bash
+    pip install -e .
+    ```
+3.  Run the application:
+    ```bash
+    lazylabel-gui
+    ```
+
+**Note**: On the first run, the application will automatically download the SAM model checkpoint (~2.5 GB) from Meta's repository to a local cache. This is a one-time download.
+
+---
+
+## ⌨️ Controls & Keybinds
+
+### Modes
+| Key | Action |
+|---|---|
+| `1` | Enter **Point Mode** (for AI segmentation). |
+| `2` | Enter **Polygon Drawing Mode**. |
+| `E` | Toggle **Selection Mode** to select existing segments. |
+| `R` | Enter **Edit Mode** for selected polygons (drag shape or vertices). |
+| `Q` | Toggle **Pan Mode** (click and drag the image). |
+
+### Actions
+| Key(s) | Action |
+|---|---|
+| `L-Click` | Add positive point (Point Mode) or polygon vertex. |
+| `R-Click` | Add negative point (Point Mode). |
+| `Ctrl + Z` | Undo last point. |
+| `Spacebar` | Finalize and save current AI segment. |
+| `Enter` | **Save final mask for the current image to a `.npz` file.** |
+| `M` | **Merge** selected segments into a single class. |
+| `V` / `Delete` / `Backspace`| **Delete** selected segments. |
+| `C` | Clear temporary points/vertices. |
+| `W/A/S/D` | Pan image. |
+| `Scroll Wheel` | Zoom-in or -out. |
+
+---
+
+## 📦 Output Format
+
+LazyLabel saves your work as a compressed NumPy array (`.npz`) with the same name as your image file.
+
+The file contains a single data key, `'mask'`, holding a **one-hot encoded tensor** with the shape `(H, W, C)`:
+* `H`: Image height.
+* `W`: Image width.
+* `C`: Total unique classes.
+
+Each channel is a binary mask for a class, combining all assigned segments into a clean, ML-ready output.
+
+---
+
+## ☕ Support LazyLabel
+[If you found LazyLabel helpful, consider supporting the project!](https://buymeacoffee.com/dnzckn)

lazylabel_gui-1.0.0/README.md

@@ -0,0 +1,98 @@
+# <img src="https://raw.githubusercontent.com/dnzckn/LazyLabel/main/src/lazylabel/demo_pictures/logo2.png" alt="LazyLabel Logo" style="height:60px; vertical-align:middle;" /> <img src="https://raw.githubusercontent.com/dnzckn/LazyLabel/main/src/lazylabel/demo_pictures/logo_black.png" alt="LazyLabel Cursive" style="height:60px; vertical-align:middle;" />
+LazyLabel is an intuitive, AI-assisted image segmentation tool. It uses Meta's Segment Anything Model (SAM) for quick, precise mask generation, alongside advanced polygon editing for fine-tuned control. Outputs are saved in a clean, one-hot encoded format for easy machine learning integration.
+
+Inspired by [LabelMe](https://github.com/wkentaro/labelme?tab=readme-ov-file#installation) and [Segment-Anything-UI](https://github.com/branislavhesko/segment-anything-ui/tree/main).
+
+![LazyLabel Screenshot](https://raw.githubusercontent.com/dnzckn/LazyLabel/main/src/lazylabel/demo_pictures/gui.PNG)
+
+---
+
+## ✨ Core Features
+
+* **AI-Powered Segmentation**: Generate masks with simple left-click (positive) and right-click (negative) interactions.
+* **Vector Polygon Tool**: Full control to draw, edit, and reshape polygons. Drag vertices or move entire shapes.
+* **Advanced Class Management**: Assign multiple segments to a single class ID for organized labeling.
+* **Intuitive Editing & Refinement**: Select, merge, and re-order segments.
+* **Interactive UI**: Color-coded segments, sortable lists, and hover highlighting.
+* **Smart I/O**: Loads existing `.npz` masks; saves work as clean, one-hot encoded outputs.
+
+---
+
+## 🚀 Getting Started
+
+### Prerequisites
+Ensure you have **Python 3.10** or newer.
+
+### Installation
+
+#### For Users (via PyPI)
+1.  Install LazyLabel directly:
+    ```bash
+    pip install lazylabel-gui
+    ```
+2.  Run the application:
+    ```bash
+    lazylabel-gui
+    ```
+
+#### For Developers (from Source)
+1.  Clone the repository:
+    ```bash
+    git clone [https://github.com/dnzckn/LazyLabel.git](https://github.com/dnzckn/LazyLabel.git)
+    cd LazyLabel
+    ```
+2.  Install in editable mode, which links the installed package to your source directory:
+    ```bash
+    pip install -e .
+    ```
+3.  Run the application:
+    ```bash
+    lazylabel-gui
+    ```
+
+**Note**: On the first run, the application will automatically download the SAM model checkpoint (~2.5 GB) from Meta's repository to a local cache. This is a one-time download.
+
+---
+
+## ⌨️ Controls & Keybinds
+
+### Modes
+| Key | Action |
+|---|---|
+| `1` | Enter **Point Mode** (for AI segmentation). |
+| `2` | Enter **Polygon Drawing Mode**. |
+| `E` | Toggle **Selection Mode** to select existing segments. |
+| `R` | Enter **Edit Mode** for selected polygons (drag shape or vertices). |
+| `Q` | Toggle **Pan Mode** (click and drag the image). |
+
+### Actions
+| Key(s) | Action |
+|---|---|
+| `L-Click` | Add positive point (Point Mode) or polygon vertex. |
+| `R-Click` | Add negative point (Point Mode). |
+| `Ctrl + Z` | Undo last point. |
+| `Spacebar` | Finalize and save current AI segment. |
+| `Enter` | **Save final mask for the current image to a `.npz` file.** |
+| `M` | **Merge** selected segments into a single class. |
+| `V` / `Delete` / `Backspace`| **Delete** selected segments. |
+| `C` | Clear temporary points/vertices. |
+| `W/A/S/D` | Pan image. |
+| `Scroll Wheel` | Zoom-in or -out. |
+
+---
+
+## 📦 Output Format
+
+LazyLabel saves your work as a compressed NumPy array (`.npz`) with the same name as your image file.
+
+The file contains a single data key, `'mask'`, holding a **one-hot encoded tensor** with the shape `(H, W, C)`:
+* `H`: Image height.
+* `W`: Image width.
+* `C`: Total unique classes.
+
+Each channel is a binary mask for a class, combining all assigned segments into a clean, ML-ready output.
+
+---
+
+## ☕ Support LazyLabel
+[If you found LazyLabel helpful, consider supporting the project!](https://buymeacoffee.com/dnzckn)

lazylabel_gui-1.0.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "lazylabel-gui"
+version = "1.0.0"
+authors = [
+  { name="Deniz N. Cakan", email="deniz.n.cakan@gmail.com" },
+]
+description = "An image segmentation GUI for generating mask tensors."
+readme = "README.md"
+license = { file="LICENSE" }
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Image Processing",
+    "Environment :: X11 Applications :: Qt",
+]
+dependencies = [
+    "PyQt6>=6.9.0",
+    "pyqtdarktheme==2.1.0",
+    "torch>=2.7.1",
+    "torchvision>=0.22.1",
+    "segment-anything==1.0",
+    "numpy>=2.3.0",
+    "opencv-python>=4.11.0.86",
+    "scipy>=1.15.3",
+    "requests>=2.32.4",
+    "tqdm>=4.67.1"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/dnzckn/lazylabel"
+"Bug Tracker" = "https://github.com/dnzckn/lazylabel/issues"
+
+[project.scripts]
+lazylabel-gui = "lazylabel.main:main"

lazylabel_gui-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

lazylabel_gui-1.0.0/src/lazylabel/controls.py

@@ -0,0 +1,108 @@
+from PyQt6.QtWidgets import (
+    QWidget,
+    QVBoxLayout,
+    QPushButton,
+    QLabel,
+    QFrame,
+    QTableWidget,
+    QTreeView,
+    QAbstractItemView,
+    QHBoxLayout,
+    QComboBox,
+    QHeaderView,
+)
+from PyQt6.QtCore import Qt
+from .reorderable_class_table import ReorderableClassTable
+
+
+class ControlPanel(QWidget):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        layout = QVBoxLayout(self)
+        layout.setAlignment(Qt.AlignmentFlag.AlignTop)
+        self.mode_label = QLabel("Mode: Points")
+        font = self.mode_label.font()
+        font.setPointSize(14)
+        font.setBold(True)
+        self.mode_label.setFont(font)
+        layout.addWidget(self.mode_label)
+        self.btn_sam_mode = QPushButton("Point Mode (1)")
+        self.btn_polygon_mode = QPushButton("Polygon Mode (2)")
+        self.btn_selection_mode = QPushButton("Selection Mode (E)")
+        layout.addWidget(self.btn_sam_mode)
+        layout.addWidget(self.btn_polygon_mode)
+        layout.addWidget(self.btn_selection_mode)
+        layout.addSpacing(20)
+        line1 = QFrame()
+        line1.setFrameShape(QFrame.Shape.HLine)
+        layout.addWidget(line1)
+        layout.addSpacing(10)
+        self.btn_clear_points = QPushButton("Clear Clicks (C)")
+        layout.addWidget(self.btn_clear_points)
+        layout.addStretch()
+        self.device_label = QLabel("Device: Unknown")
+        layout.addWidget(self.device_label)
+        self.setFixedWidth(250)
+
+
+class RightPanel(QWidget):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        layout = QVBoxLayout(self)
+
+        # File Explorer
+        file_explorer_layout = QVBoxLayout()
+        self.btn_open_folder = QPushButton("Open Image Folder")
+        self.file_tree = QTreeView()
+        file_explorer_layout.addWidget(self.btn_open_folder)
+        file_explorer_layout.addWidget(self.file_tree)
+        layout.addLayout(file_explorer_layout)
+
+        # Status Label
+        self.status_label = QLabel("")
+        self.status_label.setAlignment(Qt.AlignmentFlag.AlignCenter)
+        layout.addWidget(self.status_label)
+
+        # Segment Table
+        segment_layout = QVBoxLayout()
+        class_filter_layout = QHBoxLayout()
+        class_filter_layout.addWidget(QLabel("Filter Class:"))
+        self.class_filter_combo = QComboBox()
+        class_filter_layout.addWidget(self.class_filter_combo)
+        segment_layout.addLayout(class_filter_layout)
+
+        self.segment_table = QTableWidget()
+        self.segment_table.setColumnCount(3)
+        self.segment_table.setHorizontalHeaderLabels(["Index", "Class", "Type"])
+        self.segment_table.horizontalHeader().setSectionResizeMode(
+            QHeaderView.ResizeMode.Stretch
+        )
+        self.segment_table.setSelectionBehavior(
+            QAbstractItemView.SelectionBehavior.SelectRows
+        )
+        self.segment_table.setSortingEnabled(True)
+        segment_layout.addWidget(self.segment_table)
+
+        segment_action_layout = QHBoxLayout()
+        self.btn_merge_selection = QPushButton("Merge to Class")
+        self.btn_delete_selection = QPushButton("Delete")
+        segment_action_layout.addWidget(self.btn_merge_selection)
+        segment_action_layout.addWidget(self.btn_delete_selection)
+        segment_layout.addLayout(segment_action_layout)
+        layout.addLayout(segment_layout, 2)
+
+        # Class Table
+        class_layout = QVBoxLayout()
+        class_layout.addWidget(QLabel("Class Order:"))
+        self.class_table = ReorderableClassTable()
+        self.class_table.setColumnCount(1)
+        self.class_table.setHorizontalHeaderLabels(["Class ID"])
+        self.class_table.horizontalHeader().setSectionResizeMode(
+            QHeaderView.ResizeMode.Stretch
+        )
+        class_layout.addWidget(self.class_table)
+        self.btn_reassign_classes = QPushButton("Reassign Class IDs")
+        class_layout.addWidget(self.btn_reassign_classes)
+        layout.addLayout(class_layout, 1)
+
+        self.setFixedWidth(350)

lazylabel_gui-1.0.0/src/lazylabel/custom_file_system_model.py

@@ -0,0 +1,57 @@
+import os
+from PyQt6.QtCore import Qt, QModelIndex, QDir
+from PyQt6.QtGui import QFileSystemModel, QBrush, QColor
+
+
+class CustomFileSystemModel(QFileSystemModel):
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self.setFilter(QDir.Filter.NoDotAndDotDot | QDir.Filter.Files)
+        self.setNameFilterDisables(False)
+        self.setNameFilters(["*.png", "*.jpg", "*.jpeg", "*.tiff"])
+        self.highlighted_path = None
+
+    def set_highlighted_path(self, path):
+        self.highlighted_path = path
+
+    def columnCount(self, parent: QModelIndex = QModelIndex()) -> int:
+        return 2
+
+    def headerData(
+        self,
+        section: int,
+        orientation: Qt.Orientation,
+        role: int = Qt.ItemDataRole.DisplayRole,
+    ):
+        if (
+            orientation == Qt.Orientation.Horizontal
+            and role == Qt.ItemDataRole.DisplayRole
+        ):
+            if section == 0:
+                return "File Name"
+            if section == 1:
+                return "Mask"
+        return super().headerData(section, orientation, role)
+
+    def data(self, index: QModelIndex, role: int = Qt.ItemDataRole.DisplayRole):
+        if not index.isValid():
+            return None
+
+        # Handle the temporary highlight for saving
+        if role == Qt.ItemDataRole.BackgroundRole:
+            filePath = self.filePath(index)
+            if filePath == self.highlighted_path:
+                return QBrush(QColor("yellow"))
+
+        if index.column() == 1:
+            if role == Qt.ItemDataRole.CheckStateRole:
+                filePath = self.filePath(index.siblingAtColumn(0))
+                mask_path = os.path.splitext(filePath)[0] + ".npz"
+                return (
+                    Qt.CheckState.Checked
+                    if os.path.exists(mask_path)
+                    else Qt.CheckState.Unchecked
+                )
+            return None
+
+        return super().data(index, role)

lazylabel_gui-1.0.0/src/lazylabel/editable_vertex.py

@@ -0,0 +1,25 @@
+from PyQt6.QtWidgets import QGraphicsEllipseItem, QGraphicsItem
+from PyQt6.QtCore import Qt
+from PyQt6.QtGui import QBrush, QPen
+
+
+class EditableVertexItem(QGraphicsEllipseItem):
+    def __init__(self, main_window, segment_index, vertex_index, x, y, w, h):
+        super().__init__(x, y, w, h)
+        self.main_window = main_window
+        self.segment_index = segment_index
+        self.vertex_index = vertex_index
+
+        self.setZValue(200)
+        self.setBrush(QBrush(Qt.GlobalColor.cyan))
+        self.setPen(QPen(Qt.GlobalColor.white, 1))
+        self.setFlag(QGraphicsItem.GraphicsItemFlag.ItemIsMovable)
+        self.setFlag(QGraphicsItem.GraphicsItemFlag.ItemSendsGeometryChanges)
+
+    def itemChange(self, change, value):
+        if change == QGraphicsItem.GraphicsItemChange.ItemPositionHasChanged:
+            new_pos = value
+            self.main_window.update_vertex_pos(
+                self.segment_index, self.vertex_index, new_pos
+            )
+        return super().itemChange(change, value)

lazylabel_gui-1.0.0/src/lazylabel/hoverable_polygon_item.py

@@ -0,0 +1,23 @@
+from PyQt6.QtWidgets import QGraphicsPolygonItem
+from PyQt6.QtGui import QBrush
+
+
+class HoverablePolygonItem(QGraphicsPolygonItem):
+    def __init__(self, polygon, parent=None):
+        super().__init__(polygon, parent)
+        self.setAcceptHoverEvents(True)
+        self.default_brush = QBrush()
+        self.hover_brush = QBrush()
+
+    def set_brushes(self, default_brush, hover_brush):
+        self.default_brush = default_brush
+        self.hover_brush = hover_brush
+        self.setBrush(self.default_brush)
+
+    def hoverEnterEvent(self, event):
+        self.setBrush(self.hover_brush)
+        super().hoverEnterEvent(event)
+
+    def hoverLeaveEvent(self, event):
+        self.setBrush(self.default_brush)
+        super().hoverLeaveEvent(event)