bec-widgets 0.84.0__py3-none-any.whl → 0.85.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v0.85.0 (2024-07-16)
+
+### Feature
+
+* feat(color_map_selector): added colormap selector with plugin ([`b98fd00`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b98fd00adef97adf57f49b60ade99972b9f5a6bc))
+
 ## v0.84.0 (2024-07-15)
 
 ### Feature
@@ -133,9 +139,3 @@
 * fix(motor_control): temporary remove of motor control widgets ([`99114f1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/99114f14f62202e1fd8bf145616fa8c69937ada4))
 
 ## v0.81.0 (2024-07-06)
-
-### Feature
-
-* feat(color_button): can get colors in RGBA or HEX ([`9594be2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9594be260680d11c8550ff74ffb8d679e5a5b8f6))
-
-## v0.80.1 (2024-07-06)

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.84.0
+Version: 0.85.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/widgets/color_map_selector/color_map_selector.py

@@ -0,0 +1,111 @@
+import pyqtgraph as pg
+from qtpy.QtCore import Property, Signal, Slot
+from qtpy.QtGui import QColor, QFontMetrics, QImage
+from qtpy.QtWidgets import QApplication, QComboBox, QStyledItemDelegate, QVBoxLayout, QWidget
+
+
+class ColormapDelegate(QStyledItemDelegate):
+    def __init__(self, parent=None):
+        super(ColormapDelegate, self).__init__(parent)
+        self.image_width = 25
+        self.image_height = 10
+        self.gap = 10
+
+    def paint(self, painter, option, index):
+        text = index.data()
+        colormap = pg.colormap.get(text)
+        colors = colormap.getLookupTable(start=0.0, stop=1.0, alpha=False)
+
+        font_metrics = QFontMetrics(painter.font())
+        text_width = font_metrics.width(text)
+        text_height = font_metrics.height()
+
+        total_height = max(text_height, self.image_height)
+
+        image = QImage(self.image_width, self.image_height, QImage.Format_RGB32)
+        for i in range(self.image_width):
+            color = QColor(*colors[int(i * (len(colors) - 1) / (self.image_width - 1))])
+            for j in range(self.image_height):
+                image.setPixel(i, j, color.rgb())
+
+        painter.drawImage(
+            option.rect.x(), option.rect.y() + (total_height - self.image_height) // 2, image
+        )
+        painter.drawText(
+            option.rect.x() + self.image_width + self.gap,
+            option.rect.y() + (total_height - text_height) // 2 + font_metrics.ascent(),
+            text,
+        )
+
+
+class ColormapSelector(QWidget):
+    """
+    Simple colormap combobox widget. By  default it loads all the available colormaps in pyqtgraph.
+    """
+
+    colormap_changed_signal = Signal(str)
+
+    def __init__(self, parent=None, default_colormaps=None):
+        super().__init__(parent)
+        self._colormaps = []
+        self.initUI(default_colormaps)
+
+    def initUI(self, default_colormaps=None):
+        self.layout = QVBoxLayout(self)
+        self.combo = QComboBox()
+        self.combo.setItemDelegate(ColormapDelegate())
+        self.combo.currentTextChanged.connect(self.colormap_changed)
+        self.available_colormaps = pg.colormap.listMaps()
+        if default_colormaps is None:
+            default_colormaps = self.available_colormaps
+        self.add_color_maps(default_colormaps)
+        self.layout.addWidget(self.combo)
+
+    @Slot()
+    def colormap_changed(self):
+        """
+        Emit the colormap changed signal with the current colormap selected in the combobox.
+        """
+        self.colormap_changed_signal.emit(self.combo.currentText())
+
+    def add_color_maps(self, colormaps=None):
+        """
+        Add colormaps to the combobox.
+
+        Args:
+            colormaps(list): List of colormaps to add to the combobox. If None, all available colormaps are added.
+        """
+        self.combo.clear()
+        if colormaps is not None:
+            for name in colormaps:
+                if name in self.available_colormaps:
+                    self.combo.addItem(name)
+        else:
+            for name in self.available_colormaps:
+                self.combo.addItem(name)
+        self._colormaps = colormaps if colormaps is not None else self.available_colormaps
+
+    @Property("QStringList")
+    def colormaps(self):
+        """
+        Property to get and set the colormaps in the combobox.
+        """
+        return self._colormaps
+
+    @colormaps.setter
+    def colormaps(self, value):
+        """
+        Set the colormaps in the combobox.
+        """
+        if self._colormaps != value:
+            self._colormaps = value
+            self.add_color_maps(value)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    app = QApplication(sys.argv)
+    ex = ColormapSelector()
+    ex.show()
+    sys.exit(app.exec_())

bec_widgets/widgets/color_map_selector/color_map_selector.pyproject

@@ -0,0 +1 @@
+{'files': ['color_map_selector.py']}

bec_widgets/widgets/color_map_selector/color_map_selector_plugin.py

@@ -0,0 +1,57 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+from bec_widgets.widgets.color_map_selector.color_map_selector import ColormapSelector
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ColormapSelector' name='color_map_selector'>
+    </widget>
+</ui>
+"""
+
+
+class ColormapSelectorPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ColormapSelector(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        current_path = os.path.dirname(__file__)
+        icon_path = os.path.join(current_path, "assets", "color_map_selector_icon.png")
+        return QIcon(icon_path)
+
+    def includeFile(self):
+        return "color_map_selector"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "ColormapSelector"
+
+    def toolTip(self):
+        return "A custom QComboBox widget for selecting colormaps."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/color_map_selector/register_color_map_selector.py

@@ -0,0 +1,17 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.color_map_selector.color_map_selector_plugin import (
+        ColormapSelectorPlugin,
+    )
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(ColormapSelectorPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

{bec_widgets-0.84.0.dist-info → bec_widgets-0.85.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.84.0
+Version: 0.85.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-0.84.0.dist-info → bec_widgets-0.85.0.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=zvb4A6QI5lQTsdfI5nPPL-tUNfcrz__SQjxW03QZ5Ek,8204
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=8LHyMBpONJxRZzFKJC41_wZpRYs8xLd7LoScfoX_6yY,7418
+CHANGELOG.md,sha256=qfCubB8BgPi9QiPtGGeDxjPct_eSvK1Ep9UIP9Rgh34,7430
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=6MK38NWwgiJwKkI_rztciPHn5gYOsTyMWU4snlgNwZk,1308
+PKG-INFO,sha256=WWcaoP_OMmYA22TW83DKHT9_qQS5IpZxIOV5wcyUPkM,1308
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=Dl8H7EqAUt5W6-BJvC2tHM9ONu1ZKGBdCUI1CWm6SgI,2357
+pyproject.toml,sha256=bCu_XxdOirPXbnbNVdYtCKmbhJCJFxnxINDiZU02bnE,2357
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -78,6 +78,12 @@ bec_widgets/widgets/color_button/color_button.pyproject,sha256=LUYF4VkDOB4ttVe7Y
 bec_widgets/widgets/color_button/color_button_plugin.py,sha256=CvO3L6r8pBd-0DNuqjQ7uKF9u1mU6xFs23sS_dsj4tw,1256
 bec_widgets/widgets/color_button/register_color_button.py,sha256=ZAx3t7G2VI2S-1qcEof31Xi9O0X8deLeZNgS651L1JI,475
 bec_widgets/widgets/color_button/assets/color_button.png,sha256=dkjgGHSdxu98nM68O16fGpxBjxkkeLN8iu9M_8i5-NY,5618
+bec_widgets/widgets/color_map_selector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_widgets/widgets/color_map_selector/color_map_selector.py,sha256=V0nmY2_X76xJmLXOfjW6rG7ipJKFT8swo3bkJZDXBGE,3751
+bec_widgets/widgets/color_map_selector/color_map_selector.pyproject,sha256=sGQE4s6gia1PIz9p6c2mZX12geCk8G384gjL2PE_qEc,36
+bec_widgets/widgets/color_map_selector/color_map_selector_plugin.py,sha256=9V7xvq2SB_YZU7W1E6aEKx38REOTspFNc7x57Fyd9mY,1436
+bec_widgets/widgets/color_map_selector/register_color_map_selector.py,sha256=crZsJcH4z1DHfsfA7iHiQFDggslNyzfuHfo-YdAoca4,514
+bec_widgets/widgets/color_map_selector/assets/color_map_selector_icon.png,sha256=o8zRmMvXhGhMyBklH_Vfjn-jpDL4Nw03fLqDk_wx_JI,11975
 bec_widgets/widgets/console/console.py,sha256=IW1OerycmS-cm8CKGFig44Qye8mxsmVcKvLHAc3lXco,17845
 bec_widgets/widgets/device_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/device_box/device_box.py,sha256=ofYQJLY02pitmAJG0Y3GWBg8txNmaJDWhQVe9KFQDYA,6938
@@ -233,6 +239,7 @@ tests/unit_tests/test_bec_motor_map.py,sha256=dSYopbZS8lGD9cB26Kwmqw5zBoKCZs8t7D
 tests/unit_tests/test_bec_queue.py,sha256=u-uc-iZeGAS8P90o6Cxy5oz_60zHpirGAu04OgQPDXw,4598
 tests/unit_tests/test_bec_status_box.py,sha256=gZdjyy9DNuUP9UwleTLj2Dp5HUImiqnkHjXWiqL0Q-o,4868
 tests/unit_tests/test_client_utils.py,sha256=CBdWIVJ_UiyFzTJnX3XJm4PGw2uXhFvRCP_Y9ifckbw,2630
+tests/unit_tests/test_color_map_selector.py,sha256=NVnKrz5kFUKgljm7HslIpMII-IpzPAKHIX_KeqpNUew,1518
 tests/unit_tests/test_color_validation.py,sha256=xbFbtFDia36XLgaNrX2IwvAX3IDC_Odpj5BGoJSgiIE,2389
 tests/unit_tests/test_crosshair.py,sha256=3OMAJ2ZaISYXMOtkXf1rPdy94vCr8njeLi6uHblBL9Q,5045
 tests/unit_tests/test_device_box.py,sha256=q9IVFpt1NF3TBF0Jhk-I-LRiuvvHG3FGUalw4jEYwVo,3431
@@ -264,8 +271,8 @@ tests/unit_tests/test_configs/config_device_no_entry.yaml,sha256=hdvue9KLc_kfNzG
 tests/unit_tests/test_configs/config_scan.yaml,sha256=vo484BbWOjA_e-h6bTjSV9k7QaQHrlAvx-z8wtY-P4E,1915
 tests/unit_tests/test_msgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/test_msgs/available_scans_message.py,sha256=m_z97hIrjHXXMa2Ex-UvsPmTxOYXfjxyJaGkIY6StTY,46532
-bec_widgets-0.84.0.dist-info/METADATA,sha256=6MK38NWwgiJwKkI_rztciPHn5gYOsTyMWU4snlgNwZk,1308
-bec_widgets-0.84.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bec_widgets-0.84.0.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
-bec_widgets-0.84.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.84.0.dist-info/RECORD,,
+bec_widgets-0.85.0.dist-info/METADATA,sha256=WWcaoP_OMmYA22TW83DKHT9_qQS5IpZxIOV5wcyUPkM,1308
+bec_widgets-0.85.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.85.0.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.85.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.85.0.dist-info/RECORD,,

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.84.0"
+version = "0.85.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [

tests/unit_tests/test_color_map_selector.py

@@ -0,0 +1,43 @@
+import pyqtgraph as pg
+import pytest
+
+from bec_widgets.widgets.color_map_selector.color_map_selector import ColormapSelector
+
+
+@pytest.fixture
+def color_map_selector(qtbot):
+    widget = ColormapSelector()
+    qtbot.addWidget(widget)
+    qtbot.waitExposed(widget)
+    yield widget
+    widget.close()
+
+
+def test_color_map_selector_init(color_map_selector):
+    assert color_map_selector is not None
+    assert isinstance(color_map_selector, ColormapSelector)
+
+    all_maps = pg.colormap.listMaps()
+    loaded_maps = [
+        color_map_selector.combo.itemText(i) for i in range(color_map_selector.combo.count())
+    ]
+    assert len(loaded_maps) > 0
+    assert all_maps == loaded_maps
+
+
+def test_color_map_selector_add_color_maps(color_map_selector):
+    color_map_selector.add_color_maps(["cividis", "viridis"])
+    assert color_map_selector.combo.count() == 2
+    assert color_map_selector.combo.itemText(0) == "cividis"
+    assert color_map_selector.combo.itemText(1) == "viridis"
+    assert color_map_selector.combo.itemText(2) != "cividis"
+    assert color_map_selector.combo.itemText(2) != "viridis"
+
+
+def test_colormap_add_maps_by_property(color_map_selector):
+    color_map_selector.colormaps = ["cividis", "viridis"]
+    assert color_map_selector.combo.count() == 2
+    assert color_map_selector.combo.itemText(0) == "cividis"
+    assert color_map_selector.combo.itemText(1) == "viridis"
+    assert color_map_selector.combo.itemText(2) != "cividis"
+    assert color_map_selector.combo.itemText(2) != "viridis"