fitscube 2.3.2__tar.gz → 2.4.1__tar.gz

{fitscube-2.3.2 → fitscube-2.4.1}/.github/workflows/cd.yml

@@ -25,11 +25,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
 
-      - uses: hynek/build-and-inspect-python-package@v2
+      - uses: hynek/build-and-inspect-python-package@v2.18.0
 
   publish:
     needs: [dist]
@@ -43,13 +43,13 @@ jobs:
     if: github.event_name == 'release' && github.event.action == 'published'
 
     steps:
-      - uses: actions/download-artifact@v5
+      - uses: actions/download-artifact@v8
         with:
           name: Packages
           path: dist
 
       - name: Generate artifact attestation for sdist and wheel
-        uses: actions/attest-build-provenance@v2.4.0
+        uses: actions/attest-build-provenance@v4.1.1
         with:
           subject-path: "dist/*"
 

{fitscube-2.3.2 → fitscube-2.4.1}/.github/workflows/ci.yml

@@ -21,10 +21,10 @@ jobs:
     name: Format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v7
         with:
           python-version: "3.x"
       - uses: pre-commit/action@v3.0.1
@@ -42,11 +42,11 @@ jobs:
         runs-on: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v7
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
@@ -62,6 +62,6 @@ jobs:
           --durations=20
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v5.5.0
+        uses: codecov/codecov-action@v7.0.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

{fitscube-2.3.2 → fitscube-2.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fitscube
-Version: 2.3.2
+Version: 2.4.1
 Summary: A package to produce produce FITS cubes.
 Project-URL: Homepage, https://github.com/AlecThomson/fitscube
 Project-URL: Bug Tracker, https://github.com/AlecThomson/fitscube/issues

{fitscube-2.3.2 → fitscube-2.4.1}/fitscube/__init__.py

@@ -2,8 +2,9 @@
 
 from __future__ import annotations
 
+from fitscube.bounding_box import BoundingBox, get_common_bounding_box
 from fitscube.combine_fits import combine_fits
 
 from ._version import version as __version__
 
-__all__ = ["__version__", "combine_fits"]
+__all__ = ["BoundingBox", "__version__", "combine_fits", "get_common_bounding_box"]

{fitscube-2.3.2 → fitscube-2.4.1}/fitscube/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '2.3.2'
-__version_tuple__ = version_tuple = (2, 3, 2)
+__version__ = version = '2.4.1'
+__version_tuple__ = version_tuple = (2, 4, 1)
 
 __commit_id__ = commit_id = None

{fitscube-2.3.2 → fitscube-2.4.1}/fitscube/bounding_box.py

@@ -10,28 +10,43 @@ from pathlib import Path
 import numpy as np
 from astropy.io import fits
 
+from fitscube.asyncio import gather_with_limit, sync_wrapper
 from fitscube.logging import logger
 
 
 @dataclass(frozen=True)
 class BoundingBox:
-    """Simple container to represent a bounding box. Maximum values can be
-    used as is when slicing."""
+    """Simple container to represent a bounding box.
+
+    .. warning::
+        ``x`` and ``y`` here are the *numpy* axes, which are the reverse of the
+        FITS ``NAXIS`` convention:
+
+        - ``x`` is axis ``-2`` -- image rows -- which is ``NAXIS2`` (declination)
+        - ``y`` is axis ``-1`` -- image columns -- which is ``NAXIS1`` (right ascension)
+
+        So a plane is sliced as ``data[..., xmin:xmax, ymin:ymax]`` and the
+        trimmed header takes ``NAXIS1 = y_span``, ``NAXIS2 = x_span``.
+
+    Minimum values are inclusive and maximum values are exclusive, so both can
+    be used as is when slicing. Note that ``xmax``/``ymax`` were *inclusive*
+    prior to ``v2.3.2``.
+    """
 
     xmin: int
-    """Minimum x pixel"""
+    """Minimum row pixel (numpy axis -2, FITS NAXIS2). Inclusive."""
     xmax: int
-    """Maximum x pixel"""
+    """Maximum row pixel (numpy axis -2, FITS NAXIS2). Can be used as is in a slice (e.g. is exclusive)."""
     ymin: int
-    """Minimum y pixel. Can be used as is in slice (e.g. is exclusive). """
+    """Minimum column pixel (numpy axis -1, FITS NAXIS1). Inclusive."""
     ymax: int
-    """Maximum y pixel Can be used as is in slice (e.g. is exclusive)."""
+    """Maximum column pixel (numpy axis -1, FITS NAXIS1). Can be used as is in a slice (e.g. is exclusive)."""
     original_shape: tuple[int, int]
     """The original shape of the image. If constructed against a cube this is the shape of a single plane."""
     y_span: int
-    """The span between ymax and ymin"""
+    """The span between ymax and ymin (i.e. the trimmed NAXIS1)"""
     x_span: int
-    """The span between xmax and xmin"""
+    """The span between xmax and xmin (i.e. the trimmed NAXIS2)"""
 
 
 def create_bound_box_plane(image_data: np.ndarray) -> BoundingBox | None:
@@ -151,3 +166,40 @@ async def get_bounding_box_for_fits_coro(
         data[data == 0.0] = np.nan
 
     return await asyncio.to_thread(create_bound_box_plane, image_data=data)
+
+
+async def get_common_bounding_box_coro(
+    file_list: list[Path],
+    invalidate_zeros: bool = False,
+    max_workers: int | None = None,
+) -> BoundingBox:
+    """Compute the single bounding box that encompasses the valid data of every
+    image in ``file_list``.
+
+    This is the box that ``combine_fits`` computes internally when
+    ``bounding_box=True``. Compute it once with this function and pass the
+    result to ``combine_fits(bounding_box=...)`` when several cubes (e.g. an
+    image cube and its weights cube) must land on an identical pixel grid.
+
+    Args:
+        file_list (list[Path]): The FITS images to consider
+        invalidate_zeros (bool, optional): Mark pixels that are exactly 0.0 as invalid (NaN them). Defaults to False.
+        max_workers (int | None, optional): Maximum number of concurrent reads. Defaults to None.
+
+    Returns:
+        BoundingBox: The smallest bounding box that contains all valid data
+    """
+    boxes = await gather_with_limit(
+        max_workers,
+        *(
+            get_bounding_box_for_fits_coro(
+                fits_path=fits_path, invalidate_zeros=invalidate_zeros
+            )
+            for fits_path in file_list
+        ),
+        desc="Bounding boxes",
+    )
+    return extract_common_bounding_box(bounding_boxes=boxes)
+
+
+get_common_bounding_box = sync_wrapper(get_common_bounding_box_coro)