Removed unnecessary BaseImageItem.get_color_map_name method

Author: PierreRaybaut

CHANGELOG.md

@@ -14,6 +14,7 @@ Changes:
   * `ImageIOHandler`: removed `add_change_path` and `adapt_path` methods
 * Fix typo in `tests.features.test_colormap_editor` module: renamed function
   `test_colormap_manager` to `test_colormap_editor`
+* Removed unnecessary `BaseImageItem.get_color_map_name` method
 
 ## Version 2.2.0 ##
 

plotpy/items/image/base.py

@@ -473,19 +473,6 @@ def get_color_map(self) -> EditableColormap | None:
         """
         return self.cmap_table
 
-    def get_color_map_name(self) -> str | None:
-        """Get the current colormap name if set. The output value should not directly
-        be used to retrieve a colormap object from one of the global colormap
-        dictionaries, as the colormap name may contain capital letters whereas the
-        colormap string keys of the dictionaries are all lowercase.
-
-        Returns:
-            Colormap name
-        """
-        if self.cmap_table is None:
-            return None
-        return self.cmap_table.name
-
     def set_interpolation(self, interp_mode: int, size: int | None = None) -> None:
         """Set interpolation mode
 

plotpy/styles/image.py

@@ -35,6 +35,9 @@
 if TYPE_CHECKING:
     from guidata.dataset import DataSet
 
+    from plotpy.items import BaseImageItem
+    from plotpy.plot import BasePlot
+
 
 def _create_choices(
     dataset: DataSet, item: ImageChoiceItem, value: Any
@@ -102,13 +105,16 @@ class BaseImageParam(DataSet):
     zformat = StringItem(_("Z-Axis"), default=r"%.1f")
     _end_formats = EndGroup(_("Statistics string formatting"))
 
-    def update_param(self, image):
-        """
+    def update_param(self, image: BaseImageItem) -> None:
+        """Update the parameters from the given image item.
 
-        :param image:
+        Args:
+            image: The image item to update the parameters from.
         """
         self.label = str(image.title().text())
-        self.colormap = image.get_color_map_name()
+        cmap = image.get_color_map()
+        if cmap is not None:
+            self.colormap = cmap.name
         interpolation = image.get_interpolation()
         mode = interpolation[0]
 
@@ -120,14 +126,15 @@ def update_param(self, image):
             size = interpolation[1].shape[0]
             self.interpolation = size
 
-    def update_item(self, image):
-        """
+    def update_item(self, image: BaseImageItem) -> None:
+        """Update the given image item from the parameters.
 
-        :param image:
+        Args:
+            image: The image item to update.
         """
         if isinstance(self.alpha_function, LUTAlpha):
             self.alpha_function = self.alpha_function.value
-        plot = image.plot()
+        plot: BasePlot = image.plot()
         if plot is not None:
             plot.blockSignals(True)  # Avoid unwanted calls of update_param
             # triggered by the setter methods below
@@ -192,23 +199,27 @@ class QuadGridParam(DataSet):
     grid = BoolItem(_("Show grid"), default=False)
     gridcolor = ColorItem(_("Grid lines color"), default="black")
 
-    def update_param(self, image):
-        """
+    def update_param(self, image: BaseImageItem) -> None:
+        """Update the parameters from the given image item.
 
-        :param image:
+        Args:
+            image: The image item to update the parameters from.
         """
         self.label = str(image.title().text())
-        self.colormap = image.get_color_map_name()
+        cmap = image.get_color_map()
+        if cmap is not None:
+            self.colormap = cmap.name
         interp, uflat, vflat = image.interpolate
         self.interpolation = interp
         self.uflat = uflat
         self.vflat = vflat
         self.grid = image.grid
 
-    def update_item(self, image):
-        """
+    def update_item(self, image: BaseImageItem) -> None:
+        """Update the given image item from the parameters.
 
-        :param image:
+        Args:
+            image: The image item to update.
         """
         if isinstance(self.alpha_function, LUTAlpha):
             self.alpha_function = self.alpha_function.value

plotpy/tests/unit/test_plot_image.py

@@ -132,14 +132,16 @@ def test_colormap_tool():
 
         # default color map should be "jet"
         color_map_tool = win.manager.get_tool(ColormapTool)
-        assert item.get_color_map_name() == "jet"
+        cmap = item.get_color_map()
+        assert cmap.name == "jet"
         jet_img = plot.grab().toImage()
 
         # change the colormap
         plot.select_item(item)
         cmap_name = "accent"
         color_map_tool.activate_cmap(cmap_name)
-        assert item.get_color_map_name() == cmap_name
+        cmap = item.get_color_map()
+        assert cmap.name == cmap_name
         accent_img = plot.grab().toImage()
         assert jet_img != accent_img
 

plotpy/tools/image.py

@@ -517,14 +517,14 @@ def update_status(self, plot: BasePlot) -> None:
             plot: Plot Instance
         """
         if update_image_tool_status(self, plot):
-            item = plot.get_last_active_item(IColormapImageItemType)
+            item: BaseImageItem = plot.get_last_active_item(IColormapImageItemType)
             icon = self.default_icon
             if item:
                 self.action.setEnabled(True)
-                cmap_name = item.get_color_map_name()
-                if cmap_name:
-                    icon = build_icon_from_cmap_name(cmap_name)
-                    self._active_colormap = get_cmap(cmap_name)
+                cmap = item.get_color_map()
+                if cmap is not None:
+                    icon = build_icon_from_cmap_name(cmap.name)
+                    self._active_colormap = get_cmap(cmap.name)
             else:
                 self.action.setEnabled(False)
                 self._active_colormap = ALL_COLORMAPS["jet"]