WIP more dummy viewer stuff

Author: mwcraig

src/astro_image_display_api/dummy_viewer.py

@@ -22,19 +22,19 @@ class ImageViewer:
     # These are attributes, not methods. The type annotations are there
     # to make sure Protocol knows they are attributes. Python does not
     # do any checking at all of these types.
-    click_center: bool = False
-    click_drag: bool = True
+    _click_center: bool = False
+    _click_drag: bool = True
     scroll_pan: bool = False
     image_width: int = 0
     image_height: int = 0
     zoom_level: float = 1
-    is_marking: bool = False
+    _is_marking: bool = False
     stretch_options: tuple = ("linear", "log", "sqrt")
-    autocut_options: tuple = ("minmax", "zscale", "asinh", "percentile")
-    cursor: str = ImageViewerInterface.ALLOWED_CURSOR_LOCATIONS[0]
+    autocut_options: tuple = ("minmax", "zscale", "asinh", "percentile", "histogram")
+    _cursor: str = ImageViewerInterface.ALLOWED_CURSOR_LOCATIONS[0]
     marker: Any = "marker"
-    cuts: Any = (0, 1)
-    stretch: str = "linear"
+    _cuts: str | tuple[float] = (0, 1)
+    _stretch: str = "linear"
     # viewer: Any
 
     # Allowed locations for cursor display
@@ -59,6 +59,69 @@ class ImageViewer:
     _wcs: WCS | None = None
     _center: tuple[float, float] = (0.0, 0.0)
 
+    # Some properties where we need to control what happens
+    @property
+    def is_marking(self) -> bool:
+        return self._is_marking
+
+    @property
+    def click_center(self) -> bool:
+        return self._click_center
+
+    @click_center.setter
+    def click_center(self, value: bool) -> None:
+        if self.is_marking:
+            raise ValueError("Cannot set click_center while marking is active.")
+        self._click_center = value
+        self._click_drag = not value
+
+    @property
+    def click_drag(self) -> bool:
+        return self._click_drag
+    @click_drag.setter
+    def click_drag(self, value: bool) -> None:
+        if self.is_marking:
+            raise ValueError("Cannot set click_drag while marking is active.")
+        self._click_drag = value
+        self._click_center = not value
+
+    @property
+    def stretch(self) -> str:
+        return self._stretch
+
+    @stretch.setter
+    def stretch(self, value: str) -> None:
+        if value not in self.stretch_options:
+            raise ValueError(f"Stretch option {value} is not valid. Must be one of {self.stretch_options}.")
+        self._stretch = value
+
+    @property
+    def cuts(self) -> tuple:
+        return self._cuts
+
+    @cuts.setter
+    def cuts(self, value: tuple) -> None:
+        if isinstance(value, str):
+            if value not in self.autocut_options:
+                raise ValueError(f"Cut option {value} is not valid. Must be one of {self.autocut_options}.")
+            # A real viewer would calculate the cuts based on the data
+            self._cuts = (0, 1)
+            return
+
+        if len(value) != 2:
+            raise ValueError("Cuts must have length 2.")
+        self._cuts = value
+
+    @property
+    def cursor(self) -> str:
+        return self._cursor
+
+    @cursor.setter
+    def cursor(self, value: str) -> None:
+        if value not in self.ALLOWED_CURSOR_LOCATIONS:
+            raise ValueError(f"Cursor location {value} is not valid. Must be one of {self.ALLOWED_CURSOR_LOCATIONS}.")
+        self._cursor = value
+
     # The methods, grouped loosely by purpose
 
     # Methods for loading data
@@ -106,7 +169,8 @@ def load_nddata(self, data: NDData) -> None:
             The NDData object to load.
         """
         self._wcs = data.wcs
-        self.image_height, self.image_width = data.shape
+        # Not all NDDData objects have a shape, apparently
+        self.image_height, self.image_width = data.data.shape
         # Totally made up number...as currently defined, zoom_level means, esentially, ratio
         # of image size to viewer size.
         self.zoom_level = 1.0
@@ -128,6 +192,9 @@ def save(self, filename: str | os.PathLike, overwrite: bool = False) -> None:
             `False`.
         """
         p = Path(filename)
+        if p.exists() and not overwrite:
+            raise FileExistsError(f"File {filename} already exists. Use overwrite=True to overwrite it.")
+
         p.write_text("This is a dummy file. The viewer does not save anything.")
 
     # Marker-related methods
@@ -141,13 +208,13 @@ def start_marking(self, marker_name: str | None = None, marker: Any = None) -> N
             The name of the marker set to use. If not given, a unique
             name will be generated.
         """
-        self.is_marking = True
+        self._is_marking = True
         self._previous_click_center = self.click_center
         self._previous_click_drag = self.click_drag
         self._previous_marker = self.marker
         self._previous_scroll_pan = self.scroll_pan
-        self.click_center = False
-        self.click_drag = False
+        self._click_center = False
+        self._click_drag = False
         self.scroll_pan = True
         self._interactive_marker_name = marker_name if marker_name else self.DEFAULT_INTERACTIVE_MARKER_NAME
         self.marker = marker if marker else self.DEFAULT_INTERACTIVE_MARKER_NAME
@@ -162,7 +229,7 @@ def stop_marking(self, clear_markers: bool = False) -> None:
             If `True`, clear the markers that were created during
             interactive marking. Default is `False`.
         """
-        self.is_marking = False
+        self._is_marking = False
         self.click_center = self._previous_click_center
         self.click_drag = self._previous_click_drag
         self.scroll_pan = self._previous_scroll_pan
@@ -197,28 +264,42 @@ def add_markers(self, table: Table, x_colname: str = 'x', y_colname: str = 'y',
             The name of the marker set to use. If not given, a unique
             name will be generated.
         """
+        try:
+            coords = table[skycoord_colname]
+        except KeyError:
+            coords = None
 
         if use_skycoord:
-            coords = table[skycoord_colname]
             if self._wcs is not None:
                 x, y = self._wcs.world_to_pixel(coords)
             else:
                 raise ValueError("WCS is not set. Cannot convert to pixel coordinates.")
         else:
             x = table[x_colname]
             y = table[y_colname]
+
+            if not coords and self._wcs is not None:
+                coords = self._wcs.pixel_to_world(x, y)
+
         if marker_name in self.RESERVED_MARKER_SET_NAMES:
             raise ValueError(f"Marker name {marker_name} not allowed.")
+
         marker_name = marker_name if marker_name else self.DEFAULT_MARKER_NAME
+
+        to_add = Table(
+            dict(
+                x=x,
+                y=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])
         else:
-            marker_table = Table(names=["x", "y", "marker name"],
-                                 dtype=[float, float, str])
-
-        to_add = table[x_colname, y_colname]
-        to_add[marker_name] = marker_name
-        self._markers[marker_name] = vstack([marker_table, to_add])
+            self._markers[marker_name] = to_add
 
     def reset_markers(self) -> None:
         """
@@ -241,10 +322,14 @@ def remove_markers(self, marker_name: str | list[str] | None = None) -> None:
                 del self._markers[marker_name]
             elif marker_name == "all":
                 self._markers = {}
+            else:
+                raise ValueError(f"Marker name {marker_name} not found.")
         elif isinstance(marker_name, list):
             for name in marker_name:
                 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',
                     skycoord_colname: str = 'coord',
@@ -278,12 +363,15 @@ def get_markers(self, x_colname: str = 'x', y_colname: str = 'y',
                 marker_name = self._markers.keys()
             else:
                 marker_name = [marker_name]
+        elif marker_name is None:
+            marker_name = [self.DEFAULT_MARKER_NAME]
 
         to_stack = [self._markers[name] for name in marker_name if name in self._markers]
 
         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.rename_columns(["x", "y", "coord"], [x_colname, y_colname, skycoord_colname])
+        return result
 
 
     # Methods that modify the view
@@ -331,7 +419,7 @@ def offset_by(self, dx: float | Quantity, dy: float | Quantity) -> None:
             # This is a sky offset
             if self._wcs is not None:
                 old_center_coord = self._wcs.pixel_to_world(self._center[0], self._center[1])
-                new_center = old_center_coord.spherical_offsets_byt(dx, dy)
+                new_center = old_center_coord.spherical_offsets_by(dx, dy)
                 self.center_on(new_center)
             else:
                 raise ValueError("WCS is not set. Cannot convert to pixel coordinates.")
@@ -340,7 +428,7 @@ def offset_by(self, dx: float | Quantity, dy: float | Quantity) -> None:
             new_center = (self._center[0] + dx.value, self._center[1] + dy.value)
             self.center_on(new_center)
 
-    def zoom(self) -> None:
+    def zoom(self, val) -> None:
         """
         Zoom in or out by the given factor.
 
@@ -350,4 +438,4 @@ def zoom(self) -> None:
             The zoom level to zoom the image.
             See `zoom_level`.
         """
-        raise NotImplementedError
+        self.zoom_level *= val