WIP dummy viewer catalogs

Author: mwcraig

src/astro_image_display_api/dummy_viewer.py

@@ -29,6 +29,8 @@ class ImageViewer:
     autocut_options: tuple = ("minmax", "zscale", "asinh", "percentile", "histogram")
     _cursor: str = ImageViewerInterface.ALLOWED_CURSOR_LOCATIONS[0]
     _markers: dict[str, dict] = field(default_factory=dict)
+    _catalogs: dict[str, Table] = field(default_factory=dict)
+    _catalog_names: list[str] = field(default_factory=list)
     _default_marker_style: dict[str, Any] = field(default_factory=dict)
     _cuts: str | tuple[float, float] = (0, 1)
     _stretch: str = "linear"
@@ -47,6 +49,30 @@ def __post_init__(self):
         self._default_marker_style = dict(shape="circle", color="yellow", size=10)
         self._markers[None] = self._default_marker_style.copy()
 
+    def _user_catalog_labels(self) -> list[str]:
+        """
+        Get the user-defined catalog labels.
+        """
+        return [label for label in self._markers if label is not None]
+
+    def _resolve_catalog_label(self, catalog_label: str | None) -> list[str]:
+        user_keys = self._user_catalog_labels()
+        if catalog_label is None:
+            match len(user_keys):
+                case 0:
+                    # No user-defined styles, so return the default style
+                    catalog_label = None
+                case 1:
+                    # The user must have set a style, so return that instead of
+                    # the default style, which live in the key None.
+                    catalog_label = user_keys[0]
+                case _:
+                    raise ValueError(
+                        "Multiple catalog styles defined. Please specify a catalog_label to get the style."
+                    )
+
+        return catalog_label
+
     @property
     def stretch(self) -> str:
         return self._stretch
@@ -100,20 +126,7 @@ def get_catalog_style(self, catalog_label=None) -> dict[str, dict[str, Any]]:
         dict
             The style for the catalog.
         """
-        user_keys = list(set(self._markers.keys()) - {None})
-        if catalog_label is None:
-            match len(user_keys):
-                case 0:
-                    # No user-defined styles, so return the default style
-                    catalog_label = None
-                case 1:
-                    # The user must have set a style, so return that instead of
-                    # the default style, which live in the key None.
-                    catalog_label = user_keys[0]
-                case _:
-                    raise ValueError(
-                        "Multiple catalog styles defined. Please specify a catalog_label to get the style."
-                    )
+        catalog_label = self._resolve_catalog_label(catalog_label)
 
         style = self._markers[catalog_label]
         style["catalog_label"] = catalog_label
@@ -228,9 +241,9 @@ def save(self, filename: str | os.PathLike, overwrite: bool = False) -> None:
         p.write_text("This is a dummy file. The viewer does not save anything.")
 
     # Marker-related methods
-    def add_markers(self, table: Table, x_colname: str = 'x', y_colname: str = 'y',
+    def load_catalog(self, table: Table, x_colname: str = 'x', y_colname: str = 'y',
                     skycoord_colname: str = 'coord', use_skycoord: bool = False,
-                    marker_name: str | None = None) -> None:
+                    catalog_label: str | None = None) -> None:
         """
         Add markers to the image.
 
@@ -251,7 +264,7 @@ def add_markers(self, table: Table, x_colname: str = 'x', y_colname: str = 'y',
         use_skycoord : bool, optional
             If `True`, the ``skycoord_colname`` column will be used to
             get the marker positions. Default is `False`.
-        marker_name : str, optional
+        catalog_label : str, optional
             The name of the marker set to use. If not given, a unique
             name will be generated.
         """
@@ -279,86 +292,55 @@ def add_markers(self, table: Table, x_colname: str = 'x', y_colname: str = 'y',
                 coord=coords if coords else [None] * len(x),
             )
         )
-        to_add["marker name"] = marker_name
 
-        if marker_name in self._markers:
-            marker_table = self._markers[marker_name]
-            self._markers[marker_name] = vstack([marker_table, to_add])
+        catalog_label = self._resolve_catalog_label(catalog_label)
+        if catalog_label in self._catalogs:
+            marker_table = self._markers[catalog_label]
+            self._markers[catalog_label] = vstack([marker_table, to_add])
         else:
-            self._markers[marker_name] = to_add
-
-    def reset_markers(self) -> None:
-        """
-        Remove all markers from the image.
-        """
-        self._markers = {}
+            self._markers[catalog_label] = to_add
 
-    def remove_markers(self, marker_name: str | list[str] | None = None) -> None:
+    def remove_catalog(self, catalog_label: str | None = None) -> None:
         """
         Remove markers from the image.
 
         Parameters
         ----------
         marker_name : str, optional
-            The name of the marker set to remove. If the value is ``"all"``,
+            The name of the marker set to remove. If the value is ``"*"``,
             then all markers will be removed.
         """
-        if isinstance(marker_name, str):
-            if marker_name in self._markers:
-                del self._markers[marker_name]
-            elif marker_name == "all":
+        if isinstance(catalog_label, str):
+            if catalog_label in self._markers:
+                del self._markers[catalog_label]
+            elif catalog_label == "*":
                 self._markers = {}
             else:
-                raise ValueError(f"Marker name {marker_name} not found.")
-        elif isinstance(marker_name, list):
-            for name in marker_name:
+                raise ValueError(f"Marker name {catalog_label} not found.")
+        elif isinstance(catalog_label, list):
+            for name in catalog_label:
                 if name in self._markers:
                     del self._markers[name]
                 else:
                     raise ValueError(f"Marker name {name} not found.")
 
-    def get_markers(self, x_colname: str = 'x', y_colname: str = 'y',
+    def get_catalog(self, x_colname: str = 'x', y_colname: str = 'y',
                     skycoord_colname: str = 'coord',
-                    marker_name: str | list[str] | None = None) -> Table:
-        """
-        Get the marker positions.
-
-        Parameters
-        ----------
-        x_colname : str, optional
-            The name of the column containing the x positions. Default
-            is ``'x'``.
-        y_colname : str, optional
-            The name of the column containing the y positions. Default
-            is ``'y'``.
-        skycoord_colname : str, optional
-            The name of the column containing the sky coordinates. Default
-            is ``'coord'``.
-        marker_name : str or list of str, optional
-            The name of the marker set to use. If that value is ``"all"``,
-            then all markers will be returned.
-
-        Returns
-        -------
-        table : `astropy.table.Table`
-            The table containing the marker positions. If no markers match the
-            ``marker_name`` parameter, an empty table is returned.
-        """
-        if isinstance(marker_name, str):
-            if marker_name == "all":
-                marker_name = self._markers.keys()
-            else:
-                marker_name = [marker_name]
-        elif marker_name is None:
-            marker_name = ["_default_marker"]
+                    catalog_label: str | None = None) -> Table:
+        # Dostring is copied from the interface definition, so it is not
+        # duplicated here.
+        catalog_label = self._resolve_catalog_label(catalog_label)
 
-        to_stack = [self._markers[name] for name in marker_name if name in self._markers]
+        result = self._markers[catalog_label] if catalog_label in self._markers else Table(names=["x", "y", "coord", "marker name"])
 
-        result = vstack(to_stack) if to_stack else Table(names=["x", "y", "coord", "marker name"])
         result.rename_columns(["x", "y", "coord"], [x_colname, y_colname, skycoord_colname])
 
         return result
+    get_catalog.__doc__ = ImageViewerInterface.get_catalog.__doc__
 
+    def get_catalog_names(self) -> list[str]:
+        return list(self._user_catalog_labels())
+    get_catalog_names.__doc__ = ImageViewerInterface.get_catalog_names.__doc__
 
     # Methods that modify the view
     def center_on(self, point: tuple | SkyCoord):