Renamed CustomQwtLinearColorMap to EditableColormap

Author: PierreRaybaut

plotpy/colormaps/colormap.py

@@ -48,9 +48,7 @@
     DEFAULT_COLORMAPS_PATH,
     save_colormaps,
 )
-from plotpy.widgets.colormap.widget import (
-    CustomQwtLinearColormap,  # Reuse matplotlib data
-)
+from plotpy.widgets.colormap.widget import EditableColormap  # Reuse matplotlib data
 
 # usefull to obtain a full color map
 FULLRANGE = QwtInterval(0.0, 1.0)
@@ -68,7 +66,7 @@ def _interpolate(val, vmin, vmax):
     return (1 - interp) * vmin[1] + interp * vmax[2]
 
 
-def _setup_colormap(cmap: CustomQwtLinearColormap, cmdata):
+def _setup_colormap(cmap: EditableColormap, cmdata):
     """Setup a CustomQwtLinearColorMap according to
     matplotlib's data
     """
@@ -93,7 +91,7 @@ def _setup_colormap(cmap: CustomQwtLinearColormap, cmdata):
         cmap.addColorStop(i, col)
 
 
-def get_cmap(name: str) -> CustomQwtLinearColormap:
+def get_cmap(name: str) -> EditableColormap:
     """Get a colormap from its name
 
     Args:
@@ -106,15 +104,15 @@ def get_cmap(name: str) -> CustomQwtLinearColormap:
     if name in COLORMAPS:
         return COLORMAPS[name]
 
-    colormap = CustomQwtLinearColormap()
+    colormap = EditableColormap()
     COLORMAPS[name] = colormap
     COLORMAPS[colormap] = name
     data = getattr(_cm, "_" + name + "_data")
     _setup_colormap(colormap, data)
     return colormap
 
 
-def get_cmap_name(cmap: CustomQwtLinearColormap) -> str:
+def get_cmap_name(cmap: EditableColormap) -> str:
     """Return colormap's name
 
     Args:
@@ -143,7 +141,7 @@ def get_colormap_list() -> list[str]:
 
 
 def build_icon_from_cmap(
-    cmap: CustomQwtLinearColormap, width: int = 24, height: int = 24
+    cmap: EditableColormap, width: int = 24, height: int = 24
 ) -> QG.QIcon:
     """Builds an icon representing the colormap
 
@@ -176,7 +174,7 @@ def build_icon_from_cmap_name(cmap_name: str) -> QG.QIcon:
     return icon
 
 
-def register_extra_colormap(name: str, colormap: CustomQwtLinearColormap) -> None:
+def register_extra_colormap(name: str, colormap: EditableColormap) -> None:
     """Add a custom colormap to the list of known colormaps
     must be done early in the import process because
     datasets will use get_color_map list at import time

plotpy/items/image/base.py

@@ -58,7 +58,7 @@
 
     from plotpy.interfaces import IItemType
     from plotpy.styles.base import ItemParameters
-    from plotpy.widgets.colormap.widget import CustomQwtLinearColormap
+    from plotpy.widgets.colormap.widget import EditableColormap
 
 
 class BaseImageItem(QwtPlotItem):
@@ -416,7 +416,7 @@ def set_background_color(self, qcolor: QColor | str) -> None:
         else:
             self.lut = (a, b, np.uint32(QG.QColor(qcolor).rgb() & 0xFFFFFF), cmap)
 
-    def set_color_map(self, name_or_table: str | CustomQwtLinearColormap) -> None:
+    def set_color_map(self, name_or_table: str | EditableColormap) -> None:
         """Set colormap
 
         Args:
@@ -459,7 +459,7 @@ def set_color_map(self, name_or_table: str | CustomQwtLinearColormap) -> None:
         if plot:
             plot.update_colormap_axis(self)
 
-    def get_color_map(self) -> CustomQwtLinearColormap | None:
+    def get_color_map(self) -> EditableColormap | None:
         """Get colormap
 
         Returns:

plotpy/mathutils/colormaps.py

@@ -18,11 +18,11 @@
 from qwt import QwtInterval, toQImage
 
 from plotpy.config import CONF
-from plotpy.widgets.colormap.widget import CustomQwtLinearColormap
+from plotpy.widgets.colormap.widget import EditableColormap
 
 # from guidata.dataset.datatypes import NoDefault
 FULLRANGE = QwtInterval(0.0, 1.0)
-DEFAULT = CustomQwtLinearColormap(name="default")
+DEFAULT = EditableColormap(name="default")
 
 
 def load_raw_colormaps_from_json(
@@ -48,7 +48,7 @@ def load_raw_colormaps_from_json(
     return {}
 
 
-def load_qwt_colormaps_from_json(json_path: str) -> dict[str, CustomQwtLinearColormap]:
+def load_qwt_colormaps_from_json(json_path: str) -> dict[str, EditableColormap]:
     """Same as function load_raw_colormaps_from_json but transforms the raw colormaps
     into CustomQwtLinearColormap objects that are used by plotpy.
 
@@ -60,12 +60,12 @@ def load_qwt_colormaps_from_json(json_path: str) -> dict[str, CustomQwtLinearCol
         Dictionnary of colormpas names -> CustomQwtLinearColormap
     """
     return {
-        name.lower(): CustomQwtLinearColormap.from_iterable(iterable, name=name)
+        name.lower(): EditableColormap.from_iterable(iterable, name=name)
         for name, iterable in load_raw_colormaps_from_json(json_path).items()
     }
 
 
-def save_colormaps(json_filename: str, colormaps: dict[str, CustomQwtLinearColormap]):
+def save_colormaps(json_filename: str, colormaps: dict[str, EditableColormap]):
     """Saves colormaps into the given json file. Refer ton function get_cmap_path to
     know what json_filename can be used.
 
@@ -80,7 +80,7 @@ def save_colormaps(json_filename: str, colormaps: dict[str, CustomQwtLinearColor
 
 
 def build_icon_from_cmap(
-    cmap: CustomQwtLinearColormap, width: int = 16, height: int = 16
+    cmap: EditableColormap, width: int = 16, height: int = 16
 ) -> QG.QIcon:
     """Builds an icon representing the colormap
 
@@ -110,7 +110,7 @@ def build_icon_from_cmap_name(cmap_name: str) -> QG.QIcon:
     return build_icon_from_cmap(get_cmap(cmap_name.lower()))
 
 
-def get_cmap(cmap_name: str) -> CustomQwtLinearColormap:
+def get_cmap(cmap_name: str) -> EditableColormap:
     """Returns the colormap with the given name from the ALL_COLORMAPS global variable.
     If the colormap is not found, returns the DEFAULT colormap.
 

plotpy/tests/features/test_colormap_editor.py

@@ -19,7 +19,7 @@
 from guidata.qthelpers import qt_app_context
 
 from plotpy.widgets.colormap.editor import ColorMapEditor
-from plotpy.widgets.colormap.widget import CustomQwtLinearColormap
+from plotpy.widgets.colormap.widget import EditableColormap
 
 
 def test_colormap_manager() -> None:
@@ -39,7 +39,7 @@ def test_colormap_manager() -> None:
             "Initialization of a new colormap editor with the previous colormap: ",
             cmap_tuples,
         )
-        new_cmap = CustomQwtLinearColormap.from_iterable(cmap_tuples)
+        new_cmap = EditableColormap.from_iterable(cmap_tuples)
         print(f"{new_cmap.to_tuples()}")
         editor = ColorMapEditor(None, colormap=new_cmap)
         editor.show()
@@ -50,7 +50,7 @@ def test_colormap_manager() -> None:
             "modified post-initialization with the previous colormap: ",
             cmap_tuples,
         )
-        new_cmap = CustomQwtLinearColormap.from_iterable(cmap_tuples)
+        new_cmap = EditableColormap.from_iterable(cmap_tuples)
         editor = ColorMapEditor(None)
         editor.set_colormap(new_cmap)
         editor.show()
@@ -63,7 +63,7 @@ def test_colormap_manager() -> None:
             "255 + 1: ",
             cmap_tuples,
         )
-        new_cmap = CustomQwtLinearColormap.from_iterable(cmap_tuples)
+        new_cmap = EditableColormap.from_iterable(cmap_tuples)
         editor = ColorMapEditor(None)
         editor.set_colormap(new_cmap)
         editor.show()

plotpy/tests/features/test_colormap_manager.py

@@ -18,7 +18,7 @@
 
 from plotpy.mathutils.colormaps import ALL_COLORMAPS
 from plotpy.widgets.colormap.manager import ColorMapManager
-from plotpy.widgets.colormap.widget import CustomQwtLinearColormap
+from plotpy.widgets.colormap.widget import EditableColormap
 
 
 def test_colormap_manager() -> None:
@@ -27,7 +27,7 @@ def test_colormap_manager() -> None:
         red = QG.QColor(QC.Qt.GlobalColor.red)
         blue = QG.QColor(QC.Qt.GlobalColor.blue)
         yellow = QG.QColor(QC.Qt.GlobalColor.yellow)
-        cmap = CustomQwtLinearColormap(blue, yellow, name="kinda_viridis")
+        cmap = EditableColormap(blue, yellow, name="kinda_viridis")
         ALL_COLORMAPS["kinda_viridis"] = cmap
         dlg = ColorMapManager(None, active_colormap="YlGn")
         dlg.colormap_editor.colormap_widget.add_handle_at_relative_pos(0.5, red)

plotpy/tools/image.py

@@ -52,7 +52,7 @@
 from plotpy.tools.misc import OpenFileTool
 from plotpy.tools.shape import CircleTool, RectangleTool, RectangularShapeTool
 from plotpy.widgets.colormap.manager import ColorMapManager
-from plotpy.widgets.colormap.widget import CustomQwtLinearColormap
+from plotpy.widgets.colormap.widget import EditableColormap
 from plotpy.widgets.imagefile import exec_image_save_dialog
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -454,9 +454,7 @@ def __init__(
             tip=_("Select colormap for active image"),
             toolbar_id=toolbar_id,
         )
-        self._active_colormap: CustomQwtLinearColormap = ALL_COLORMAPS.get(
-            "jet", DEFAULT
-        )
+        self._active_colormap: EditableColormap = ALL_COLORMAPS.get("jet", DEFAULT)
         self.default_icon = build_icon_from_cmap_name(self._active_colormap.name)
         if self.action is not None:
             self.action.setEnabled(False)
@@ -498,13 +496,13 @@ def get_selected_images(self, plot: BasePlot) -> list[IBasePlotItem]:
                 items = [active_image]
         return items
 
-    def activate_cmap(self, cmap: str | CustomQwtLinearColormap) -> None:
+    def activate_cmap(self, cmap: str | EditableColormap) -> None:
         """Activate the given colormap. Supports mutliple input types.
 
         Args:
             cmap: Cmap to apply for currently selected images.
         """
-        assert isinstance(cmap, (str, CustomQwtLinearColormap))
+        assert isinstance(cmap, (str, EditableColormap))
         if isinstance(cmap, str):
             self._active_colormap = get_cmap(cmap)
         else:

plotpy/widgets/colormap/editor.py

@@ -19,7 +19,7 @@
 from guidata.dataset.qtwidgets import DataSetEditGroupBox
 
 from plotpy.config import _
-from plotpy.widgets.colormap.widget import ColorMapWidget, CustomQwtLinearColormap
+from plotpy.widgets.colormap.widget import ColorMapWidget, EditableColormap
 
 
 class ColorPickDataSet(DataSet):
@@ -116,7 +116,7 @@ def __init__(
         cmap_height: int = 50,
         color1: QG.QColor | None = None,
         color2: QG.QColor | None = None,
-        colormap: CustomQwtLinearColormap | None = None,
+        colormap: EditableColormap | None = None,
     ) -> None:
         super().__init__(parent)
 
@@ -148,7 +148,7 @@ def __init__(
             self.update_current_dataset
         )
 
-    def set_colormap(self, colormap: CustomQwtLinearColormap) -> None:
+    def set_colormap(self, colormap: EditableColormap) -> None:
         """Replaces the current colormap.
 
         Args:
@@ -159,7 +159,7 @@ def set_colormap(self, colormap: CustomQwtLinearColormap) -> None:
         self.colormap_widget.blockSignals(False)
         self.setup_tabs()
 
-    def get_colormap(self) -> CustomQwtLinearColormap:
+    def get_colormap(self) -> EditableColormap:
         """Get the current colormap being edited.
 
         Returns:

plotpy/widgets/colormap/manager.py

@@ -28,7 +28,7 @@
     save_colormaps,
 )
 from plotpy.widgets.colormap.editor import ColorMapEditor
-from plotpy.widgets.colormap.widget import CustomQwtLinearColormap
+from plotpy.widgets.colormap.widget import EditableColormap
 
 
 class ColorMapNameEdit(QW.QDialog):
@@ -109,7 +109,7 @@ def __init__(
         self.setWindowIcon(get_icon("cmap_edit.png"))
         self.setWindowTitle(_("Colormap manager"))
 
-        self.__returned_colormap: CustomQwtLinearColormap | None = None
+        self.__returned_colormap: EditableColormap | None = None
 
         if active_colormap is None or active_colormap.lower() not in ALL_COLORMAPS:
             active_colormap = next(iter(ALL_COLORMAPS))
@@ -200,13 +200,13 @@ def set_colormap(self, index: int) -> None:
         Args:
             index: index of the colormap in the QComboBox.
         """
-        cmap_copy: CustomQwtLinearColormap = deepcopy(self._cmap_choice.itemData(index))
+        cmap_copy: EditableColormap = deepcopy(self._cmap_choice.itemData(index))
         self.colormap_editor.set_colormap(cmap_copy)
         is_new_colormap = cmap_copy.name.lower() not in ALL_COLORMAPS
         self._changes_saved = True
         self._save_btn.setEnabled(is_new_colormap)
 
-    def get_colormap(self) -> CustomQwtLinearColormap:
+    def get_colormap(self) -> EditableColormap:
         """Return the selected colormap object.
 
         Returns:
@@ -263,12 +263,10 @@ def __get_new_colormap_name(self, title: str, name: str) -> str | None:
 
     def new_colormap(self) -> None:
         """Create a new colormap and set it as the current colormap."""
-        cmap = CustomQwtLinearColormap(
-            QG.QColor(0), QG.QColor(4294967295), name=_("New")
-        )
+        cmap = EditableColormap(QG.QColor(0), QG.QColor(4294967295), name=_("New"))
         self.save_colormap(cmap)
 
-    def save_colormap(self, cmap: CustomQwtLinearColormap | None = None) -> bool:
+    def save_colormap(self, cmap: EditableColormap | None = None) -> bool:
         """Saves the current colormap and handles the validation process. The saved
         colormaps can only be saved in the custom colormaps.
 

plotpy/widgets/colormap/widget.py

@@ -29,7 +29,7 @@
 ]
 
 
-class CustomQwtLinearColormap(QwtLinearColorMap):
+class EditableColormap(QwtLinearColorMap):
     """Overload of the QwtLinearColorMap class to add some features. This class is
     temporary and should be removed when its features are added to QwtPython.
 
@@ -106,7 +106,7 @@ def update_stops_steps(self, stop_index: int) -> None:
     @classmethod
     def from_iterable(
         cls, iterable: Sequence[tuple[float, str]], name=None
-    ) -> "CustomQwtLinearColormap":
+    ) -> "EditableColormap":
         """Converts the given iterable of tuples to a colormap (instance of Self).
         The iterable must be at least of length 2. If the iterable is of length 1,
         the colormap will be composed of two identical colors. If the iterable is
@@ -243,7 +243,7 @@ def __init__(
         cmap_height: int = 50,
         color1: QG.QColor | None = None,
         color2: QG.QColor | None = None,
-        colormap: CustomQwtLinearColormap | None = None,
+        colormap: EditableColormap | None = None,
     ) -> None:
         super().__init__(parent)
 
@@ -274,7 +274,7 @@ def __init__(
         if colormap is None:
             color1 = QG.QColor(QC.Qt.GlobalColor.blue) if color1 is None else color1
             color2 = QG.QColor(QC.Qt.GlobalColor.yellow) if color2 is None else color2
-            self._colormap = CustomQwtLinearColormap(color1, color2)
+            self._colormap = EditableColormap(color1, color2)
         else:
             self._colormap = colormap
             self.set_handles_values(colormap.colorStops())
@@ -302,7 +302,7 @@ def __init__(
         self.multi_range_hslider.sliderReleased.connect(self.release_handle)
         self.customContextMenuRequested.connect(self.open_slider_menu)
 
-    def set_colormap(self, colormap: CustomQwtLinearColormap) -> None:
+    def set_colormap(self, colormap: EditableColormap) -> None:
         """Replaces the current colormap.
 
         Args:
@@ -313,7 +313,7 @@ def set_colormap(self, colormap: CustomQwtLinearColormap) -> None:
         self.set_handles_values(new_values)
         self.COLORMAP_CHANGED.emit()
 
-    def get_colormap(self) -> CustomQwtLinearColormap:
+    def get_colormap(self) -> EditableColormap:
         """Get the current colormap being edited.
 
         Returns: