Merge pull request #378 from pkgw/blank-fits

Deal with integer FITS files with BLANK keywords

ci/azure-build-and-test.yml

@@ -21,7 +21,7 @@ parameters:
       PYTHON_SERIES: "3.10"
 
   - name: macos_310
-    vmImage: macos-12
+    vmImage: macos-14
     vars:
       PYTHON_SERIES: "3.10"
 

ci/azure-job-setup.yml

@@ -79,17 +79,20 @@ steps:
   - bash: |
       set -euo pipefail
 
-      if [[ $AGENT_OS == Windows_NT ]] ; then
+      if [[ $AGENT_OS == Darwin ]] ; then
+        # As of macos-14, these no longer have Anaconda built in.
+        CONDA="$TMPDIR/conda"
+        curl -fsSL https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-x86_64.sh >miniforge.sh
+        bash miniforge.sh -f -b -p "$CONDA"
+        rm -f miniforge.sh
+        condabin="$CONDA/bin"
+      elif [[ $AGENT_OS == Windows_NT ]] ; then
         CONDA=$(echo "$CONDA" | sed -e 's|\\|\/|g' -e 's|^\([A-Za-z]\)\:/\(.*\)|/\L\1\E/\2|')
         condabin="$CONDA/Scripts"
       else
         condabin="$CONDA/bin"
       fi
 
-      if [[ $AGENT_OS == Darwin ]] ; then
-        sudo chown -R $USER $CONDA
-      fi
-
       cat >activate-conda.sh <<EOF
       eval "\$($condabin/conda shell.bash hook)"
       conda activate

docs/api/pywwt.BaseWWTWidget.rst

@@ -12,6 +12,8 @@ BaseWWTWidget
 
       ~BaseWWTWidget.actual_planet_scale
       ~BaseWWTWidget.alt_az_grid
+      ~BaseWWTWidget.alt_az_grid_color
+      ~BaseWWTWidget.alt_az_text
       ~BaseWWTWidget.available_hips_catalog_names
       ~BaseWWTWidget.available_layers
       ~BaseWWTWidget.available_views
@@ -20,18 +22,27 @@ BaseWWTWidget
       ~BaseWWTWidget.constellation_boundary_color
       ~BaseWWTWidget.constellation_figure_color
       ~BaseWWTWidget.constellation_figures
+      ~BaseWWTWidget.constellation_labels
+      ~BaseWWTWidget.constellation_pictures
       ~BaseWWTWidget.constellation_selection
       ~BaseWWTWidget.constellation_selection_color
       ~BaseWWTWidget.crosshairs
       ~BaseWWTWidget.crosshairs_color
       ~BaseWWTWidget.current_mode
       ~BaseWWTWidget.ecliptic
+      ~BaseWWTWidget.ecliptic_color
       ~BaseWWTWidget.ecliptic_grid
+      ~BaseWWTWidget.ecliptic_grid_color
+      ~BaseWWTWidget.ecliptic_text
       ~BaseWWTWidget.foreground
       ~BaseWWTWidget.foreground_opacity
       ~BaseWWTWidget.galactic_grid
+      ~BaseWWTWidget.galactic_grid_color
       ~BaseWWTWidget.galactic_mode
+      ~BaseWWTWidget.galactic_text
       ~BaseWWTWidget.grid
+      ~BaseWWTWidget.grid_color
+      ~BaseWWTWidget.grid_text
       ~BaseWWTWidget.imagery
       ~BaseWWTWidget.instruments
       ~BaseWWTWidget.layers
@@ -40,6 +51,8 @@ BaseWWTWidget
       ~BaseWWTWidget.location_latitude
       ~BaseWWTWidget.location_longitude
       ~BaseWWTWidget.most_recent_source
+      ~BaseWWTWidget.precession_chart
+      ~BaseWWTWidget.precession_chart_color
       ~BaseWWTWidget.selected_sources
       ~BaseWWTWidget.solar_system
 
@@ -58,11 +71,13 @@ BaseWWTWidget
       ~BaseWWTWidget.get_center
       ~BaseWWTWidget.get_current_time
       ~BaseWWTWidget.get_fov
+      ~BaseWWTWidget.get_roll
       ~BaseWWTWidget.load_image_collection
       ~BaseWWTWidget.load_tour
       ~BaseWWTWidget.pause_time
       ~BaseWWTWidget.pause_tour
       ~BaseWWTWidget.play_time
+      ~BaseWWTWidget.refresh_tile_cache
       ~BaseWWTWidget.reset
       ~BaseWWTWidget.reset_view
       ~BaseWWTWidget.resume_tour
@@ -75,6 +90,8 @@ BaseWWTWidget
 
    .. autoattribute:: actual_planet_scale
    .. autoattribute:: alt_az_grid
+   .. autoattribute:: alt_az_grid_color
+   .. autoattribute:: alt_az_text
    .. autoattribute:: available_hips_catalog_names
    .. autoattribute:: available_layers
    .. autoattribute:: available_views
@@ -83,18 +100,27 @@ BaseWWTWidget
    .. autoattribute:: constellation_boundary_color
    .. autoattribute:: constellation_figure_color
    .. autoattribute:: constellation_figures
+   .. autoattribute:: constellation_labels
+   .. autoattribute:: constellation_pictures
    .. autoattribute:: constellation_selection
    .. autoattribute:: constellation_selection_color
    .. autoattribute:: crosshairs
    .. autoattribute:: crosshairs_color
    .. autoattribute:: current_mode
    .. autoattribute:: ecliptic
+   .. autoattribute:: ecliptic_color
    .. autoattribute:: ecliptic_grid
+   .. autoattribute:: ecliptic_grid_color
+   .. autoattribute:: ecliptic_text
    .. autoattribute:: foreground
    .. autoattribute:: foreground_opacity
    .. autoattribute:: galactic_grid
+   .. autoattribute:: galactic_grid_color
    .. autoattribute:: galactic_mode
+   .. autoattribute:: galactic_text
    .. autoattribute:: grid
+   .. autoattribute:: grid_color
+   .. autoattribute:: grid_text
    .. autoattribute:: imagery
    .. autoattribute:: instruments
    .. autoattribute:: layers
@@ -103,6 +129,8 @@ BaseWWTWidget
    .. autoattribute:: location_latitude
    .. autoattribute:: location_longitude
    .. autoattribute:: most_recent_source
+   .. autoattribute:: precession_chart
+   .. autoattribute:: precession_chart_color
    .. autoattribute:: selected_sources
    .. autoattribute:: solar_system
 
@@ -119,11 +147,13 @@ BaseWWTWidget
    .. automethod:: get_center
    .. automethod:: get_current_time
    .. automethod:: get_fov
+   .. automethod:: get_roll
    .. automethod:: load_image_collection
    .. automethod:: load_tour
    .. automethod:: pause_time
    .. automethod:: pause_tour
    .. automethod:: play_time
+   .. automethod:: refresh_tile_cache
    .. automethod:: reset
    .. automethod:: reset_view
    .. automethod:: resume_tour

docs/api/pywwt.core.BaseWWTWidget.rst

@@ -77,6 +77,7 @@ BaseWWTWidget
       ~BaseWWTWidget.pause_time
       ~BaseWWTWidget.pause_tour
       ~BaseWWTWidget.play_time
+      ~BaseWWTWidget.refresh_tile_cache
       ~BaseWWTWidget.reset
       ~BaseWWTWidget.reset_view
       ~BaseWWTWidget.resume_tour
@@ -152,6 +153,7 @@ BaseWWTWidget
    .. automethod:: pause_time
    .. automethod:: pause_tour
    .. automethod:: play_time
+   .. automethod:: refresh_tile_cache
    .. automethod:: reset
    .. automethod:: reset_view
    .. automethod:: resume_tour

docs/api/pywwt.traits.to_hex.rst

@@ -0,0 +1,6 @@
+to_hex
+======
+
+.. currentmodule:: pywwt.traits
+
+.. autofunction:: to_hex

docs/clear-automodapis.sh

@@ -0,0 +1,46 @@
+#! /bin/bash
+
+# For URL structure reasons, our "api/" directory has a mixture of "root" files
+# that must exist (the ones for each module) and other files that live in
+# version control but are generated by the automodapi system. In order to
+# refresh the latter files, they must be deleted before running a doc build.
+# This script does that, while leaving the "root" files.
+
+apidir=$(dirname $0)/api
+
+cd "$apidir"
+
+for f in *.rst; do
+    case "$f" in
+    pywwt.rst|\
+    pywwt.annotation_.rst|\
+    pywwt.app.rst|\
+    pywwt.core.rst|\
+    pywwt.data_server.rst|\
+    pywwt.imagery.rst|\
+    pywwt.instruments.rst|\
+    pywwt.jupyter_relay.rst|\
+    pywwt.jupyter.rst|\
+    pywwt.jupyter_server.rst|\
+    pywwt.layers.rst|\
+    pywwt.logger.rst|\
+    pywwt.qt.rst|\
+    pywwt.solar_system.rst|\
+    pywwt.traits.rst|\
+    pywwt.utils.rst|\
+    pywwt.windows.rst|\
+    pywwt.windows.client.rst|\
+    pywwt.windows.layer.rst|\
+    pywwt.windows.misc.rst|\
+    pywwt.windows.mods.rst|\
+    pywwt.windows.utils.rst) ;;
+
+    *) rm -f "$f"
+    esac
+done
+
+echo "- Restoring files to work around issue with traitlets inherited members"
+
+for c in AstropyQuantity Color ColorWithOpacity ; do
+    git restore pywwt.traits.$c.rst
+done

pywwt/layers.py

@@ -243,6 +243,7 @@ def add_image_layer(
         self,
         image=None,
         hdu_index=None,
+        wcs_key=" ",
         verbose=True,
         name=None,
         tiling_method=TilingMethod.AUTO_DETECT,
@@ -270,6 +271,11 @@ def add_image_layer(
             by using a list of integers like this: [0, 2, 1]. If hdu_index is
             not set, toasty will use the first HDU with tilable content in each
             FITS.
+        wcs_key : optional str or list of str, defaults to " "
+            Specify which set of WCS keywords to load from each input HDU. If
+            the *image* input is a list of FITS, you can specify the wcs_key of
+            each FITS by using a list of letters like this: [" ", "C", "A"]. If
+            If a scalar value is given, the same value will be used for all inputs.
         verbose : optional boolean, defaults True
             If true, progress messages will be printed as the FITS files are
             being processed.
@@ -316,7 +322,8 @@ def add_image_layer(
             image = [image]
 
         if (
-            tiling_method == TilingMethod.TOAST
+            wcs_key != " "
+            or tiling_method == TilingMethod.TOAST
             or tiling_method == TilingMethod.HIPS
             or tiling_method == TilingMethod.TAN
         ) or (
@@ -329,6 +336,7 @@ def add_image_layer(
                 self._tile_and_serve(
                     fits_list=image,
                     hdu_index=hdu_index,
+                    wcs_key=wcs_key,
                     cli_progress=verbose,
                     display_name=name,
                     tiling_method=tiling_method,
@@ -438,6 +446,7 @@ async def _tile_and_serve(
         self,
         fits_list,
         hdu_index=None,
+        wcs_key=" ",
         cli_progress=True,
         display_name=None,
         tiling_method=TilingMethod.AUTO_DETECT,
@@ -449,6 +458,7 @@ async def _tile_and_serve(
             out_dir, builder = toasty.tile_fits(
                 fits_list,
                 hdu_index=hdu_index,
+                wcs_key=wcs_key,
                 cli_progress=cli_progress,
                 tiling_method=tiling_method,
                 **kwargs

pywwt/utils.py

@@ -1,6 +1,7 @@
 import numpy as np
 import pytz
 from astropy.io import fits
+from astropy.io.fits import CompImageHDU, ImageHDU, PrimaryHDU
 from astropy.coordinates import ICRS
 from astropy.time import Time
 from datetime import datetime
@@ -49,8 +50,27 @@ def transform_to_wwt_supported_fits(image, output_file, overwrite):
     with warnings.catch_warnings():
         # Sorry, Astropy, no one cares if you fixed the FITS.
         warnings.simplefilter("ignore")
+
+        # Inner workaround: as of October 2024, `reproject` will crash with
+        # integer-valued images that have the "BLANK" keyword set:
+        # https://github.com/astropy/reproject/issues/475 . This issue should of
+        # course be fixed upstream, but a fix will take a while to propagate
+        # through the ecosystem. In the meantime, fiddle with things to avoid
+        # the issue if it looks like it might be relevant.
+        do_blank_workaround = (
+            isinstance(image, (PrimaryHDU, ImageHDU, CompImageHDU))
+            and image.header.get("BLANK") is not None
+            and hasattr(image, "_data_replaced")
+        )
+        if do_blank_workaround:
+            old_data_replaced = image._data_replaced
+            image._data_replaced = True
+
         data, wcs = parse_input_data(image)
 
+        if do_blank_workaround:
+            image._data_replaced = old_data_replaced
+
     if wcs.naxis != 2:
         if not wcs.has_celestial:
             raise Exception(

setup.py

@@ -119,7 +119,7 @@
         "pytz",
         "reproject>=0.8",
         "requests",
-        "toasty>=0.18",
+        "toasty>=0.20",
         "tornado",
         "traitlets>=5",
         "wwt_data_formats>=0.12",