asp-plot 1.6.4__tar.gz → 1.7.0__tar.gz

{asp_plot-1.6.4 → asp_plot-1.7.0}/.gitignore

@@ -136,3 +136,4 @@ scratch/
 notebooks/**/*.parquet
 notebooks/**/*.csv
 CLAUDE*
+.claude/**

{asp_plot-1.6.4 → asp_plot-1.7.0}/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.7.0] - 2026-02-24
+
+### Added
+- ASP version and asp_plot version displayed on report title page
+- Copyright overlay ("© Vantor {year}") on WorldView satellite imagery in scene, match point, and detailed hillshade plots
+- `detect_vantor_satellite()` utility to identify WorldView imagery from XML SATID tags
+- `add_copyright_overlay()` utility for matplotlib axes
+- `ProcessingParameters.get_asp_version()` method to extract ASP version from log files
+- `Raster._mask_nodata()` private helper to consolidate nodata/invalid value masking
+- `Raster._load_and_diff_rasters_da()` private static method returning xarray DataArray for raster differencing
+
+### Changed
+- `Raster.get_bounds()` now uses `self.ds.bounds` (rasterio) instead of opening a redundant rioxarray dataset
+- `Raster.compute_difference()` uses `rio.to_raster()` for saving when `save=True`, avoiding manual profile construction
+- `StereoPlotter.plot_detailed_hillshade()` reuses existing `raster.ds.transform` instead of reopening the DEM file
+- Consolidated duplicated nodata masking logic into `Raster._mask_nodata()`
+- Updated ASTER and WorldView example notebooks
+
 ## [1.6.4] - 2026-02-17
 
 ### Changed

{asp_plot-1.6.4 → asp_plot-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asp_plot
-Version: 1.6.4
+Version: 1.7.0
 Summary: Package for plotting outputs Ames Stereo Pipeline processing
 Project-URL: Homepage, https://github.com/uw-cryo/asp_plot
 Project-URL: Issues, https://github.com/uw-cryo/asp_plot/issues
@@ -31,12 +31,13 @@ Description-Content-Type: text/markdown
 
 # asp_plot
 
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14263122.svg)](https://doi.org/10.5281/zenodo.14263122)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14263121.svg)](https://doi.org/10.5281/zenodo.14263121)
 
 Scripts and notebooks to visualize output from the [NASA Ames Stereo Pipeline (ASP)](https://github.com/NeoGeographyToolkit/StereoPipeline).
 
 > [!IMPORTANT]
-> [View an example WorldView report here](notebooks/WorldView/asp_plot_report_atlanta_tile.pdf).
+> [View an example WorldView report here](https://github.com/uw-cryo/asp_plot/blob/main/notebooks/WorldView/asp_plot_report_atlanta_tile.pdf).
+> [View example modular plotting usage here](https://github.com/uw-cryo/asp_plot/tree/main/notebooks)
 >
 
 ## Motivation

{asp_plot-1.6.4 → asp_plot-1.7.0}/README.md

@@ -1,11 +1,12 @@
 # asp_plot
 
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14263122.svg)](https://doi.org/10.5281/zenodo.14263122)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14263121.svg)](https://doi.org/10.5281/zenodo.14263121)
 
 Scripts and notebooks to visualize output from the [NASA Ames Stereo Pipeline (ASP)](https://github.com/NeoGeographyToolkit/StereoPipeline).
 
 > [!IMPORTANT]
-> [View an example WorldView report here](notebooks/WorldView/asp_plot_report_atlanta_tile.pdf).
+> [View an example WorldView report here](https://github.com/uw-cryo/asp_plot/blob/main/notebooks/WorldView/asp_plot_report_atlanta_tile.pdf).
+> [View example modular plotting usage here](https://github.com/uw-cryo/asp_plot/tree/main/notebooks)
 >
 
 ## Motivation

asp_plot-1.7.0/asp_plot/__init__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("asp_plot")
+except PackageNotFoundError:
+    __version__ = "unknown"

{asp_plot-1.6.4 → asp_plot-1.7.0}/asp_plot/processing_parameters.py

@@ -103,6 +103,37 @@ class ProcessingParameters:
         except:
             self.point2dem_log = None
 
+    def get_asp_version(self):
+        """Extract the ASP version string from the first available log file.
+
+        Returns
+        -------
+        str
+            ASP version string (e.g., "3.4.0-alpha"), or "N/A" if not found.
+        """
+        log_candidates = []
+        if self.bundle_adjust_log:
+            log_candidates.append(self.bundle_adjust_log)
+        if self.stereo_logs:
+            pprc = next(
+                (log for log in self.stereo_logs if "log-stereo_pprc" in log),
+                None,
+            )
+            if pprc:
+                log_candidates.append(pprc)
+        if self.point2dem_log:
+            log_candidates.append(self.point2dem_log)
+
+        for log_file in log_candidates:
+            try:
+                with open(log_file, "r") as f:
+                    first_line = f.readline().strip()
+                if first_line.startswith("ASP "):
+                    return first_line[4:]
+            except Exception:
+                continue
+        return "N/A"
+
     def from_log_files(self):
         """
         Extract processing parameters from log files.
@@ -157,6 +188,7 @@ class ProcessingParameters:
         point2dem_params = "point2dem " + point2dem_params.split(maxsplit=1)[1]
 
         self.processing_parameters_dict = {
+            "asp_version": self.get_asp_version(),
             "processing_timestamp": processing_timestamp,
             "reference_dem": reference_dem,
             "bundle_adjust": bundle_adjust_params,

{asp_plot-1.6.4 → asp_plot-1.7.0}/asp_plot/report.py

@@ -152,6 +152,27 @@ def compile_report(
         new_x="LMARGIN",
         new_y="NEXT",
     )
+    asp_version = processing_parameters_dict.get("asp_version", "")
+    if asp_version:
+        pdf.cell(
+            0,
+            8,
+            f"ASP version: {asp_version}",
+            align="C",
+            new_x="LMARGIN",
+            new_y="NEXT",
+        )
+
+    from asp_plot import __version__
+
+    pdf.cell(
+        0,
+        8,
+        f"asp_plot version: {__version__}",
+        align="C",
+        new_x="LMARGIN",
+        new_y="NEXT",
+    )
     pdf.ln(10)
 
     if report_metadata is not None:

{asp_plot-1.6.4 → asp_plot-1.7.0}/asp_plot/scenes.py

@@ -3,7 +3,14 @@ import os
 
 import matplotlib.pyplot as plt
 
-from asp_plot.utils import Plotter, Raster, glob_file, save_figure
+from asp_plot.utils import (
+    Plotter,
+    Raster,
+    add_copyright_overlay,
+    detect_vantor_satellite,
+    glob_file,
+    save_figure,
+)
 
 logging.basicConfig(level=logging.WARNING)
 logger = logging.getLogger(__name__)
@@ -64,6 +71,8 @@ class ScenePlotter(Plotter):
         self.stereo_directory = stereo_directory
         self.full_stereo_directory = os.path.join(directory, stereo_directory)
 
+        self.is_vantor = detect_vantor_satellite(self.directory)
+
         self.left_scene_sub_fn = glob_file(self.full_stereo_directory, "*-L_sub.tif")
         self.right_scene_sub_fn = glob_file(self.full_stereo_directory, "*-R_sub.tif")
 
@@ -110,10 +119,14 @@ class ScenePlotter(Plotter):
         left_scene_ma = left_scene.read_array()
         self.plot_array(ax=axa[0], array=left_scene_ma, cmap="gray", add_cbar=False)
         axa[0].set_title(f"Left\n{os.path.basename(self.left_scene_sub_fn)}", size=8)
+        if self.is_vantor:
+            add_copyright_overlay(axa[0])
 
         right_scene_ma = Raster(self.right_scene_sub_fn).read_array()
         self.plot_array(ax=axa[1], array=right_scene_ma, cmap="gray", add_cbar=False)
         axa[1].set_title(f"Right\n{os.path.basename(self.right_scene_sub_fn)}", size=8)
+        if self.is_vantor:
+            add_copyright_overlay(axa[1])
 
         fig.tight_layout()
         if save_dir and fig_fn:

{asp_plot-1.6.4 → asp_plot-1.7.0}/asp_plot/stereo.py

@@ -9,7 +9,15 @@ import rasterio as rio
 from matplotlib_scalebar.scalebar import ScaleBar
 
 from asp_plot.processing_parameters import ProcessingParameters
-from asp_plot.utils import ColorBar, Plotter, Raster, glob_file, save_figure
+from asp_plot.utils import (
+    ColorBar,
+    Plotter,
+    Raster,
+    add_copyright_overlay,
+    detect_vantor_satellite,
+    glob_file,
+    save_figure,
+)
 
 logging.basicConfig(level=logging.WARNING)
 logger = logging.getLogger(__name__)
@@ -90,6 +98,7 @@ class StereoPlotter(Plotter):
         super().__init__(**kwargs)
         self.directory = directory
         self.stereo_directory = stereo_directory
+        self.is_vantor = detect_vantor_satellite(self.directory)
 
         if reference_dem:
             self.reference_dem = reference_dem
@@ -331,6 +340,10 @@ class StereoPlotter(Plotter):
                 s=1,
             )
             axa[1].set_aspect("equal")
+
+            if self.is_vantor:
+                add_copyright_overlay(axa[0])
+                add_copyright_overlay(axa[1])
         else:
             axa[0].text(
                 0.5,
@@ -647,14 +660,14 @@ class StereoPlotter(Plotter):
             ]
             self._plot_hillshade_with_overlay(ax_hs, dem_subset, hs_subset, gsd)
 
-            with rio.open(self.dem_fn) as src:
-                transform = src.transform
-                ul_x, ul_y = rio.transform.xy(
-                    transform, idx[0] * subset_size, idx[1] * subset_size
-                )
-                lr_x, lr_y = rio.transform.xy(
-                    transform, (idx[0] + 1) * subset_size, (idx[1] + 1) * subset_size
-                )
+            ul_x, ul_y = rio.transform.xy(
+                raster.ds.transform, idx[0] * subset_size, idx[1] * subset_size
+            )
+            lr_x, lr_y = rio.transform.xy(
+                raster.ds.transform,
+                (idx[0] + 1) * subset_size,
+                (idx[1] + 1) * subset_size,
+            )
 
             # We only show the corresponding image if it is mapprojected
             if self.orthos:
@@ -671,6 +684,8 @@ class StereoPlotter(Plotter):
                     cmap="gray",
                     add_cbar=False,
                 )
+                if self.is_vantor:
+                    add_copyright_overlay(ax_img)
                 axes_to_modify = [ax_hs, ax_img]
             else:
                 plt.delaxes(ax_img)

{asp_plot-1.6.4 → asp_plot-1.7.0}/asp_plot/utils.py

@@ -1,6 +1,7 @@
 import glob
 import logging
 import os
+import re
 import subprocess
 import warnings
 
@@ -529,6 +530,27 @@ class Raster:
 
         return (height, width)
 
+    def _mask_nodata(self, array):
+        """
+        Apply nodata and invalid value masking to a raster array.
+
+        Handles two cases that rasterio's masked=True alone does not:
+        1. Undeclared nodata values (inferred by get_ndv() from pixel data)
+        2. Invalid values (inf, nan) that may exist in ASP outputs
+
+        Parameters
+        ----------
+        array : numpy.ndarray
+            Raw raster array (may already be partially masked from rasterio)
+
+        Returns
+        -------
+        numpy.ma.MaskedArray
+            Array with nodata and invalid values masked
+        """
+        ndv = self.get_ndv()
+        return np.ma.fix_invalid(np.ma.masked_equal(array, ndv))
+
     def read_array(self, b=1, extent=False):
         """
         Read raster data as a numpy masked array.
@@ -559,8 +581,7 @@ class Raster:
         else:
             a = self.ds.read(b, masked=True)
 
-        ndv = self.get_ndv()
-        ma = np.ma.fix_invalid(np.ma.masked_equal(a, ndv))
+        ma = self._mask_nodata(a)
         out = ma
         if extent:
             extent = rio.plot.plotting_extent(self.ds)
@@ -590,9 +611,7 @@ class Raster:
         """
         window = from_bounds(*bbox, self.ds.transform)
         subset = self.ds.read(b, window=window, masked=True)
-        ndv = self.get_ndv()
-        ma = np.ma.fix_invalid(np.ma.masked_equal(subset, ndv))
-        return ma
+        return self._mask_nodata(subset)
 
     def get_ndv(self):
         """
@@ -672,8 +691,7 @@ class Raster:
             If json_format=True: list of corner coordinates as dictionaries
             If json_format=False: tuple of (min_x, min_y, max_x, max_y)
         """
-        ds = rioxarray.open_rasterio(self.fn, masked=True).squeeze()
-        bounds = ds.rio.bounds()
+        bounds = self.ds.bounds
         if latlon:
             epsg = self.get_epsg_code()
             bounds = rio.warp.transform_bounds(f"EPSG:{epsg}", "EPSG:4326", *bounds)
@@ -736,13 +754,9 @@ class Raster:
         Aligns rasters to the grid of the second raster before differencing.
         If save=True, saves the difference raster with "_diff.tif" suffix.
         """
-        # Load and align rasters, with second raster as reference (cropped to intersection)
-        diff_data, dst_transform, dst_crs, nodata = self.load_and_diff_rasters(
-            self.fn, second_fn
-        )
-
-        # Optionally save difference raster
         if save:
+            diff_da, nodata = self._load_and_diff_rasters_da(self.fn, second_fn)
+
             outdir = os.path.dirname(os.path.abspath(self.fn))
             outprefix = (
                 os.path.splitext(os.path.split(self.fn)[1])[0]
@@ -751,24 +765,13 @@ class Raster:
             )
             dst_fn = os.path.join(outdir, outprefix + "_diff.tif")
 
-            # Save with the intersection's grid parameters
-            height, width = diff_data.shape
-            profile = {
-                "driver": "GTiff",
-                "dtype": rio.float32,
-                "width": width,
-                "height": height,
-                "count": 1,
-                "crs": dst_crs,
-                "transform": dst_transform,
-                "nodata": nodata,
-                "compress": "lzw",
-            }
-
-            with rio.open(dst_fn, "w", **profile) as dst:
-                dst.write(diff_data.filled(nodata).astype(rio.float32), 1)
-
-        return diff_data
+            diff_da.rio.write_nodata(nodata, inplace=True)
+            diff_da.rio.to_raster(dst_fn, dtype="float32", compress="lzw")
+
+            return np.ma.masked_invalid(diff_da.values)
+        else:
+            diff_data, _, _, _ = self.load_and_diff_rasters(self.fn, second_fn)
+            return diff_data
 
     @staticmethod
     def save_raster(data, output_fn, reference_fn, dtype=None, nodata=None):
@@ -819,9 +822,9 @@ class Raster:
                 dst.write(data.astype(profile["dtype"]), 1)
 
     @staticmethod
-    def load_and_diff_rasters(first_fn, second_fn):
+    def _load_and_diff_rasters_da(first_fn, second_fn):
         """
-        Load two rasters, align them, and compute their difference.
+        Load two rasters, align them, and compute their difference as a DataArray.
 
         Parameters
         ----------
@@ -833,7 +836,7 @@ class Raster:
         Returns
         -------
         tuple
-            (difference array (second_raster - first_raster), transform, CRS, nodata)
+            (difference xarray.DataArray, nodata value)
 
         Notes
         -----
@@ -841,35 +844,49 @@ class Raster:
         grid before differencing. Both rasters are cropped to their intersection first
         (matching geoutils behavior). Uses rioxarray for efficient reprojection.
         """
-        # Load rasters with rioxarray
         first = rioxarray.open_rasterio(first_fn, masked=True).squeeze()
         second = rioxarray.open_rasterio(second_fn, masked=True).squeeze()
 
-        # Get first raster's bounds in second raster's CRS
         first_bounds_in_ref_crs = first.rio.transform_bounds(second.rio.crs)
-
-        # Clip second raster to first raster's bounds (intersection)
         second_clipped = second.rio.clip_box(*first_bounds_in_ref_crs)
-
-        # Reproject first raster to match clipped second raster's grid
         first_reproj = first.rio.reproject_match(second_clipped)
 
-        # Compute difference: second - first
         diff = second_clipped - first_reproj
 
-        # Extract metadata
-        dst_transform = second_clipped.rio.transform()
-        dst_crs = second_clipped.rio.crs
         nodata = (
             second.rio.encoded_nodata
             if second.rio.encoded_nodata is not None
             else -9999
         )
 
-        # Convert to numpy masked array
-        diff_array = np.ma.masked_invalid(diff.values)
+        return diff, nodata
 
-        return diff_array, dst_transform, dst_crs, nodata
+    @staticmethod
+    def load_and_diff_rasters(first_fn, second_fn):
+        """
+        Load two rasters, align them, and compute their difference.
+
+        Parameters
+        ----------
+        first_fn : str
+            Path to the first raster file
+        second_fn : str
+            Path to the second raster file (used as reference grid)
+
+        Returns
+        -------
+        tuple
+            (difference array (second_raster - first_raster), transform, CRS, nodata)
+
+        Notes
+        -----
+        The first raster is reprojected and resampled to match the second raster's
+        grid before differencing. Both rasters are cropped to their intersection first
+        (matching geoutils behavior). Uses rioxarray for efficient reprojection.
+        """
+        diff, nodata = Raster._load_and_diff_rasters_da(first_fn, second_fn)
+        diff_array = np.ma.masked_invalid(diff.values)
+        return diff_array, diff.rio.transform(), diff.rio.crs, nodata
 
 
 class Plotter:
@@ -1045,3 +1062,57 @@ class Plotter:
 
         if ctx_kwargs:
             ctx.add_basemap(ax=ax, **ctx_kwargs)
+
+
+def detect_vantor_satellite(directory):
+    """Check if XML files in directory indicate a Vantor (WorldView) satellite.
+
+    Parameters
+    ----------
+    directory : str
+        Path to directory containing XML camera model files.
+
+    Returns
+    -------
+    bool
+        True if any XML file contains a WorldView SATID (WV01, WV02, WV03, etc.).
+    """
+    try:
+        xml_files = glob_file(directory, "*.[Xx][Mm][Ll]", all_files=True)
+    except Exception:
+        return False
+    if not xml_files:
+        return False
+    xml_files = [f for f in xml_files if not re.search(r".*ortho.*\.xml", f)]
+    for xml_file in xml_files:
+        try:
+            satid = get_xml_tag(xml_file, "SATID")
+            if satid.startswith("WV"):
+                return True
+        except (ValueError, Exception):
+            continue
+    return False
+
+
+def add_copyright_overlay(ax):
+    """Add Vantor copyright text overlay to the bottom-right of a matplotlib axes.
+
+    Parameters
+    ----------
+    ax : matplotlib.axes.Axes
+        The axes to add the copyright overlay to.
+    """
+    from datetime import datetime
+
+    year = datetime.now().year
+    ax.text(
+        0.98,
+        0.02,
+        f"\u00a9 Vantor {year}",
+        transform=ax.transAxes,
+        fontsize=7,
+        color="white",
+        ha="right",
+        va="bottom",
+        bbox=dict(boxstyle="round,pad=0.3", facecolor="black", alpha=0.5),
+    )

{asp_plot-1.6.4 → asp_plot-1.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "asp_plot"
-version = "1.6.4"
+version = "1.7.0"
 license = {text = "BSD-3-Clause"}
 authors = [
   { name="Ben Purinton", email="purinton@uw.edu" },