Remove colormap_options

Author: mwcraig

src/astro_image_display_api/dummy_viewer.py

@@ -59,9 +59,6 @@ class ImageViewer:
     # Allowed locations for cursor display
     ALLOWED_CURSOR_LOCATIONS: tuple = ImageViewerInterface.ALLOWED_CURSOR_LOCATIONS
 
-    # Minimal required colormaps
-    MINIMUM_REQUIRED_COLORMAPS: tuple[str, ...] = ImageViewerInterface.MINIMUM_REQUIRED_COLORMAPS
-
     # some internal variable for keeping track of viewer state
     _wcs: WCS | None = None
     _center: tuple[numbers.Real, numbers.Real] = (0.0, 0.0)
@@ -154,15 +151,7 @@ def set_cuts(self, value: tuple[numbers.Real, numbers.Real] | BaseInterval, imag
             raise ValueError(f"Image label '{image_label}' not found. Please load an image first.")
         self._images[image_label].cuts = self._cuts
 
-    @property
-    def colormap_options(self) -> list[str]:
-        return list(self.MINIMUM_REQUIRED_COLORMAPS)
-    colormap_options.__doc__ = ImageViewerInterface.colormap_options.__doc__
-
     def set_colormap(self, map_name: str, image_label: str | None = None) -> None:
-        if map_name.lower() not in self.colormap_options:
-            raise ValueError(f"Invalid colormap '{map_name}'. Must be one of {self.colormap_options}.")
-
         image_label = self._resolve_image_label(image_label)
         if image_label not in self._images:
             raise ValueError(f"Image label '{image_label}' not found. Please load an image first.")

src/astro_image_display_api/interface_definition.py

@@ -3,32 +3,13 @@
 import os
 
 from astropy.coordinates import SkyCoord
-from astropy.nddata import NDData
 from astropy.table import Table
 from astropy.units import Quantity
 from astropy.visualization import BaseInterval, BaseStretch
 
-from numpy.typing import ArrayLike
 
 # Allowed locations for cursor display
 ALLOWED_CURSOR_LOCATIONS = ('top', 'bottom', None)
-MINIMUM_REQUIRED_COLORMAPS = (
-    'gray',
-    'viridis',
-    'plasma',
-    'inferno',
-    'magma',
-    'purple-blue',
-    'yellow-green-blue',
-    'yellow-orange-red',
-    'red-purple',
-    'blue-green',
-    'hot',
-    'red-blue',
-    'red-yellow-blue',
-    'purple-orange',
-    'purple-green',
-)
 
 __all__ = [
     'ImageViewerInterface',
@@ -47,9 +28,6 @@ class ImageViewerInterface(Protocol):
     # Allowed locations for cursor display
     ALLOWED_CURSOR_LOCATIONS: tuple = ALLOWED_CURSOR_LOCATIONS
 
-    # Required colormaps for the viewer
-    MINIMUM_REQUIRED_COLORMAPS: tuple[str, ...] = MINIMUM_REQUIRED_COLORMAPS
-
     # The methods, grouped loosely by purpose
 
     # Method for loading image data
@@ -157,10 +135,10 @@ def set_colormap(self, map_name: str, image_label: str | None = None) -> None:
         Parameters
         ----------
         map_name : str
-            The name of the colormap to set. This should be a valid
-            colormap name from Matplotlib; not all backends will support
+            The name of the colormap to set. This should be a
+            valid colormap name from Matplotlib`_;
+            not all backends will support
             all colormaps, so the viewer should handle errors gracefully.
-            The case of the `map_name` is not important.
         image_label : str, optional
             The label of the image to set the colormap for. If not given and there is
             only one image loaded, the colormap for that image is set. If there are
@@ -171,6 +149,8 @@ def set_colormap(self, map_name: str, image_label: str | None = None) -> None:
         ValueError
             If the `map_name` is not a valid colormap name or if the `image_label`
             is not provided when there are multiple images loaded.
+
+        .. _Matplotlib: https://matplotlib.org/stable/gallery/color/colormap_reference.html
         """
         raise NotImplementedError
 
@@ -199,19 +179,6 @@ def get_colormap(self, image_label: str | None = None) -> str:
         """
         raise NotImplementedError
 
-    @property
-    @abstractmethod
-    def colormap_options(self) -> list[str]:
-        """
-        Get the list of available colormaps.
-
-        Returns
-        -------
-        list of str
-            A list of available colormap names.
-        """
-        raise NotImplementedError
-
     # Saving contents of the view and accessing the view
     @abstractmethod
     def save(self, filename: str | os.PathLike, overwrite: bool = False) -> None:

src/astro_image_display_api/widget_api_test.py

@@ -718,11 +718,6 @@ def test_stretch_cuts_errors(self, data):
         with pytest.raises(ValueError, match='[Ii]mage label.*not found'):
             self.image.set_cuts((10, 100), image_label='not a valid label')
 
-    def test_colormap_options(self):
-        cmap_list = self.image.colormap_options
-        assert set(ImageViewerInterface.MINIMUM_REQUIRED_COLORMAPS) <= set(cmap_list)
-        assert set(self.image.MINIMUM_REQUIRED_COLORMAPS) == set(ImageViewerInterface.MINIMUM_REQUIRED_COLORMAPS)
-
     def test_set_get_colormap(self, data):
         # Check setting and getting with a single image label.
         self.image.load_image(data, image_label='test')
@@ -753,9 +748,6 @@ def test_set_colormap_errors(self, data):
         # is not in the list of allowed colormaps.
         self.image.load_image(data, image_label='test')
 
-        with pytest.raises(ValueError, match='[Ii]nvalid colormap'):
-            self.image.set_colormap('not a valid colormap')
-
         # Check that getting a colormap for an image label that does not exist
         with pytest.raises(ValueError, match='[Ii]mage label.*not found'):
             self.image.get_colormap(image_label='not a valid label')