Add image label to stretch/cuts in interface

Author: mwcraig

src/astro_image_display_api/interface_definition.py

@@ -58,7 +58,7 @@ def load_image(self, data: Any, image_label: str | None = None) -> None:
 
     # Setting and getting image properties
     @abstractmethod
-    def set_cuts(self, cuts: tuple | BaseInterval) -> None:
+    def set_cuts(self, cuts: tuple | BaseInterval, image_label: str | None = None) -> None:
         """
         Set the cuts for the image.
 
@@ -68,14 +68,25 @@ def set_cuts(self, cuts: tuple | BaseInterval) -> None:
             The cuts to set. If a tuple, it should be of the form
             ``(min, max)`` and will be interpreted as a
             `~astropy.visualization.ManualInterval`.
+
+        image_label : str, optional
+            The label of the image to set the cuts for. If not given and there is
+            only one image loaded, the cuts for that image are set.
         """
         raise NotImplementedError
 
     @abstractmethod
-    def get_cuts(self) -> BaseInterval:
+    def get_cuts(self, image_label: str | None = None) -> BaseInterval:
         """
         Get the current cuts for the image.
 
+        Parameters
+        ----------
+        image_label : str, optional
+            The label of the image to get the cuts for. If not given and there is
+            only one image loaded, the cuts for that image are returned. If there are
+            multiple images and no label is provided, an error is raised.
+
         Returns
         -------
         cuts : `~astropy.visualization.BaseInterval`
@@ -84,7 +95,7 @@ def get_cuts(self) -> BaseInterval:
         raise NotImplementedError
 
     @abstractmethod
-    def set_stretch(self, stretch: BaseStretch) -> None:
+    def set_stretch(self, stretch: BaseStretch, image_label: str | None = None) -> None:
         """
         Set the stretch for the image.
 
@@ -93,14 +104,25 @@ def set_stretch(self, stretch: BaseStretch) -> None:
         stretch : Any stretch from `~astropy.visualization`
             The stretch to set. This can be any subclass of
             `~astropy.visualization.BaseStretch`.
+
+        image_label : str, optional
+            The label of the image to set the cuts for. If not given and there is
+            only one image loaded, the cuts for that image are set.
         """
         raise NotImplementedError
 
     @abstractmethod
-    def get_stretch(self) -> BaseStretch:
+    def get_stretch(self, image_label: str | None = None) -> BaseStretch:
         """
         Get the current stretch for the image.
 
+        Parameters
+        ----------
+        image_label : str, optional
+            The label of the image to get the cuts for. If not given and there is
+            only one image loaded, the cuts for that image are returned. If there are
+            multiple images and no label is provided, an error is raised.
+
         Returns
         -------
         stretch : `~astropy.visualization.BaseStretch`