Colormaps: fixed some critical bugs

Image colormap parameters (dataset) + Case issue / global variable issue

Author: PierreRaybaut

plotpy/mathutils/colormaps.py

@@ -22,7 +22,7 @@
 
 # from guidata.dataset.datatypes import NoDefault
 FULLRANGE = QwtInterval(0.0, 1.0)
-DEFAULT = EditableColormap(name="default")
+DEFAULT = EditableColormap(name="jet")
 
 
 def load_raw_colormaps_from_json(
@@ -122,9 +122,23 @@ def get_cmap(cmap_name: str) -> EditableColormap:
         A CustomQwtLinearColormap instance corresponding to the given name, if no
         colormap is found, returns the DEFAULT colormap.
     """
+    global ALL_COLORMAPS
     return ALL_COLORMAPS.get(cmap_name.lower(), DEFAULT)
 
 
+def add_cmap(cmap: EditableColormap) -> None:
+    """Adds the given colormap to both ALL_COLORMAPS and CUSTOM_COLORMAPS global
+    variables.
+
+    Args:
+        cmap: colormap to add
+    """
+    global ALL_COLORMAPS, CUSTOM_COLORMAPS
+    ALL_COLORMAPS[cmap.name.lower()] = cmap
+    CUSTOM_COLORMAPS[cmap.name.lower()] = cmap
+    save_colormaps(CUSTOM_COLORMAPS_PATH, CUSTOM_COLORMAPS)
+
+
 def get_cmap_path(config_path: str):
     """Takes a file path (i.e. from the CONF global variable) and tries to find it in
     this order:

plotpy/styles/image.py

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+
 from __future__ import annotations
 
-from typing import Callable
+from typing import TYPE_CHECKING, Any, Callable
 
 import numpy as np
 from guidata.dataset import (
@@ -25,11 +26,17 @@
 from plotpy.mathutils.colormaps import ALL_COLORMAPS, build_icon_from_cmap_name
 from plotpy.styles.base import ItemParameters
 
+if TYPE_CHECKING:
+    from guidata.dataset import DataSet
+
 
-def _create_choices() -> list[tuple[str, str, Callable[[str], QG.QIcon]]]:
+def _create_choices(
+    dataset: DataSet, item: ImageChoiceItem, value: Any
+) -> list[tuple[str, str, Callable[[str], QG.QIcon]]]:
+    """Create the list of choices for the colormap item."""
     choices: list[tuple[str, str, Callable[[str], QG.QIcon]]] = []
-    for cmap_name in ALL_COLORMAPS:
-        choices.append((cmap_name, cmap_name, build_icon_from_cmap_name))
+    for cmap in ALL_COLORMAPS.values():
+        choices.append((cmap.name, cmap.name, build_icon_from_cmap_name))
     return choices
 
 
@@ -52,9 +59,9 @@ class BaseImageParam(DataSet):
         _("Global alpha"), default=1.0, min=0, max=1, help=_("Global alpha value")
     )
     _hide_colormap = False
-    colormap = ImageChoiceItem(
-        _("Colormap"), _create_choices(), default="jet"
-    ).set_prop("display", hide=GetAttrProp("_hide_colormap"))
+    colormap = ImageChoiceItem(_("Colormap"), _create_choices, default="jet").set_prop(
+        "display", hide=GetAttrProp("_hide_colormap")
+    )
 
     interpolation = ChoiceItem(
         _("Interpolation"),
@@ -134,9 +141,9 @@ class QuadGridParam(DataSet):
         _("Global alpha"), default=1.0, min=0, max=1, help=_("Global alpha value")
     )
     _hide_colormap = False
-    colormap = ImageChoiceItem(
-        _("Colormap"), _create_choices(), default="jet"
-    ).set_prop("display", hide=GetAttrProp("_hide_colormap"))
+    colormap = ImageChoiceItem(_("Colormap"), _create_choices, default="jet").set_prop(
+        "display", hide=GetAttrProp("_hide_colormap")
+    )
 
     interpolation = ChoiceItem(
         _("Interpolation"),

plotpy/tools/image.py

@@ -34,10 +34,6 @@
 )
 from plotpy.mathutils.colormaps import (
     ALL_COLORMAPS,
-    CUSTOM_COLORMAPS,
-    DEFAULT,
-    DEFAULT_COLORMAPS,
-    build_icon_from_cmap,
     build_icon_from_cmap_name,
     get_cmap,
 )
@@ -454,7 +450,7 @@ def __init__(
             tip=_("Select colormap for active image"),
             toolbar_id=toolbar_id,
         )
-        self._active_colormap: EditableColormap = ALL_COLORMAPS.get("jet", DEFAULT)
+        self._active_colormap: EditableColormap = ALL_COLORMAPS["jet"]
         self.default_icon = build_icon_from_cmap_name(self._active_colormap.name)
         if self.action is not None:
             self.action.setEnabled(False)
@@ -534,7 +530,7 @@ def update_status(self, plot: BasePlot) -> None:
                     self._active_colormap = get_cmap(cmap_name)
             else:
                 self.action.setEnabled(False)
-                self._active_colormap = ALL_COLORMAPS.get("jet", DEFAULT)
+                self._active_colormap = ALL_COLORMAPS["jet"]
             self.action.setIcon(icon)
 
 

plotpy/widgets/colormap/manager.py

@@ -22,10 +22,9 @@
 from plotpy.mathutils.colormaps import (
     ALL_COLORMAPS,
     CUSTOM_COLORMAPS,
-    CUSTOM_COLORMAPS_PATH,
     DEFAULT_COLORMAPS,
+    add_cmap,
     build_icon_from_cmap,
-    save_colormaps,
 )
 from plotpy.widgets.colormap.editor import ColorMapEditor
 from plotpy.widgets.colormap.widget import EditableColormap
@@ -297,8 +296,7 @@ def save_colormap(self, cmap: EditableColormap | None = None) -> bool:
             new_name = CUSTOM_COLORMAPS[new_name.lower()].name
 
         cmap.name = new_name
-        CUSTOM_COLORMAPS[new_name] = ALL_COLORMAPS[new_name] = cmap
-        save_colormaps(CUSTOM_COLORMAPS_PATH, CUSTOM_COLORMAPS)
+        add_cmap(cmap)
 
         icon = build_icon_from_cmap(cmap)
         if is_existing_custom_cmap: