eye-patch 1.0.0__py3-none-any.whl

eye_patch/naming.py

@@ -0,0 +1,40 @@
+from pathlib import Path
+from typing import NamedTuple
+
+
+class FITSMaskNames(NamedTuple):
+    """Contains the names of the FITS images created when creating a mask image/
+    These are only the names, and do not mean that they are necessarily created.
+    """
+
+    mask_fits: Path
+    """Name of the mask FITS file"""
+    signal_fits: Path | None = None
+    """Name of the signal FITS file"""
+    scale_mask_fits: Path | None = None
+    """Path to a FITS file that describes per-scale clean masks. Scales are represented with a bit-mapped values,"""
+
+
+def create_fits_mask_names(
+    fits_image: str | Path, include_signal_path: bool = False
+) -> FITSMaskNames:
+    """Create the names that will be used when generate FITS mask products
+
+    Args:
+        fits_image (Union[str,]Path): Base name of the output files
+        include_signal_path (bool, optional): If True, also include ``signal_fits`` in the output. Defaults to False.
+
+    Returns:
+        FITSMaskNames: collection of names used for the signal and mask FITS images
+    """
+    fits_image = Path(fits_image)
+
+    fits_signal = (
+        fits_image.with_suffix(".signal.fits") if include_signal_path else None
+    )
+    fits_mask = fits_image.with_suffix(".mask.fits")
+    fits_scale_mask = fits_image.with_suffix(".scalemask.fits")
+
+    return FITSMaskNames(
+        signal_fits=fits_signal, mask_fits=fits_mask, scale_mask_fits=fits_scale_mask
+    )

eye_patch/pixel_utils.py

@@ -0,0 +1,101 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+import astropy.units as u
+import numpy as np
+from astropy.io import fits
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from radio_beam import Beam
+
+
+@dataclass(frozen=True)
+class BeamShape:
+    """A simple container to represent a fitted 2D gaussian,
+    intended for the main lobe of the synthesised beam. This
+    class has been defined to avoid issues with the serialisation
+    of astropy.units, which can cause strange and wonderful
+    errors when being sent over the wire to workers."""
+
+    bmaj_arcsec: float
+    """The size of the major-axis of the beam, in arcseconds."""
+    bmin_arcsec: float
+    """The size of the minor-axis of the beam, in arcseconds."""
+    bpa_deg: float
+    """Rotation of the beam, in degrees."""
+
+    @classmethod
+    def from_radio_beam(cls, radio_beam: Beam) -> BeamShape:
+        """A helper function to convert a radio_beam.Beam into a
+        BeamShape. This is prinicpally intended to be used when
+        there is a need to exchange a Beam between processes
+        that would need to serialise the object.
+
+        Args:
+            radio_beam (Beam): The Beam to convert to normalised and known units
+
+        Returns:
+            BeamShape: The normalised container without astropy units.
+        """
+        return cls(
+            bmaj_arcsec=radio_beam.major.to(u.arcsecond).value,
+            bmin_arcsec=radio_beam.minor.to(u.arcsecond).value,
+            bpa_deg=radio_beam.pa.to(u.degree).value,
+        )
+
+
+def get_beam_shape(fits_path: Path) -> BeamShape | None:
+    """Construct and return a beam shape from the fields in a FITS image
+
+    Args:
+        fits_path (Path): FITS image to extract the beam information from
+
+    Returns:
+        Optional[BeamShape]: Shape of the beam stored in the FITS image. None is returned if the beam is not found.
+    """
+
+    header = fits.getheader(filename=fits_path)
+
+    if not all(key in header for key in ("BMAJ", "BMIN", "BPA")):
+        return None
+
+    return BeamShape(
+        bmaj_arcsec=header["BMAJ"] * 3600,
+        bmin_arcsec=header["BMIN"] * 3600,
+        bpa_deg=header["BPA"],
+    )
+
+
+def get_pixels_per_beam(fits_path: Path) -> float | None:
+    """Given a image with beam information, return the number of pixels
+    per beam. The beam is taken from the FITS header. This is evaluated
+    for pixels at the reference pixel position.
+
+    Args:
+        fits_path (Path): FITS image to consideer
+
+    Returns:
+        float | None: Number of pixels per beam. If beam is not in header then None is returned.
+    """
+
+    beam_shape = get_beam_shape(fits_path=fits_path)
+
+    if beam_shape is None:
+        return None
+
+    header = fits.getheader(filename=fits_path)
+
+    pixel_ra = np.abs(header["CDELT1"] * 3600)
+    pixel_dec = np.abs(header["CDELT2"] * 3600)
+
+    assert isinstance(beam_shape, BeamShape), (
+        f"Expected type of Beamshape, but have {type(beam_shape)}"
+    )
+    beam_area = beam_shape.bmaj_arcsec * beam_shape.bmin_arcsec * np.pi
+    pixel_area = pixel_ra * pixel_dec
+
+    return float(beam_area / pixel_area)

eye_patch-1.0.0.dist-info/METADATA

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: eye-patch
+Version: 1.0.0
+Summary: The pirate mask.
+Project-URL: Homepage, https://github.com/flint-crew/eye-patch
+Project-URL: Bug Tracker, https://github.com/flint-crew/eye-patch/issues
+Project-URL: Discussions, https://github.com/flint-crew/eye-patch/discussions
+Project-URL: Changelog, https://github.com/flint-crew/eye-patch/releases
+Author-email: Alec Thomson <alec.thomson@skao.int>, Tim Galvin <tim.galvin@csiro.au>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: astropy>=7.2.0
+Requires-Dist: capn-crunch>=1.1.0
+Requires-Dist: numpy>=2.4.3
+Requires-Dist: radio-beam>=0.3.9
+Requires-Dist: reproject>=0.19.0
+Requires-Dist: scipy
+Description-Content-Type: text/markdown
+
+# Eye Patch
+
+The pirate mask!
+
+<img width="256" height="256" alt="image" src="https://github.com/user-attachments/assets/2a8e442c-036b-4d78-8370-180c02588c95" />
+
+[![Actions Status][actions-badge]][actions-link]
+[![Documentation Status][rtd-badge]][rtd-link]
+[![PyPI version][pypi-version]][pypi-link]
+[![PyPI platforms][pypi-platforms]][pypi-link]
+[![Coverage][coverage-badge]][coverage-link]
+
+<!-- SPHINX-START -->
+
+<!-- prettier-ignore-start -->
+[actions-badge]:            https://github.com/flint-crew/eye-patch/workflows/CI/badge.svg
+[actions-link]:             https://github.com/flint-crew/eye-patch/actions
+[pypi-link]:                https://pypi.org/project/eye-patch/
+[pypi-platforms]:           https://img.shields.io/pypi/pyversions/eye-patch
+[pypi-version]:             https://img.shields.io/pypi/v/eye-patch
+[rtd-badge]:                https://readthedocs.org/projects/eye-patch/badge/?version=latest
+[rtd-link]:                 https://eye-patch.readthedocs.io/en/latest/?badge=latest
+[coverage-badge]:           https://codecov.io/github/flint-crew/eye-patch/branch/main/graph/badge.svg
+[coverage-link]:            https://codecov.io/github/flint-crew/eye-patch
+
+<!-- prettier-ignore-end -->

eye_patch-1.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+eye_patch/__init__.py,sha256=jtfBWiVBoQK4SZa31vnjnSf_E7MIWA-gOG0iNisCRYs,200
+eye_patch/_version.py,sha256=JAAyU3al4wmBf3BF-Umm1J_GrCIT-yS_yWEGHqKRVHc,520
+eye_patch/_version.pyi,sha256=o7uNL6MhuJoiqpEnriU7rBT6TmkJZA-i2qMoNz9YcgQ,82
+eye_patch/masking.py,sha256=cgphN8ouM6ncWmzbMLt7zfqXxTa9W0diPAe68722494,47897
+eye_patch/naming.py,sha256=GsI_790GsJXepqyW5nDLu2o29f8DLtabOI837D81be8,1417
+eye_patch/pixel_utils.py,sha256=QRU6qHovnkvEgOvRvTRQY5Scvlse4RRL0aquNwjlBgA,3162
+eye_patch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eye_patch-1.0.0.dist-info/METADATA,sha256=Os3xd5KXMM9iHUh6IFkCH3JmOTxI8sc9Ea47jgJ5tqs,2623
+eye_patch-1.0.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+eye_patch-1.0.0.dist-info/entry_points.txt,sha256=ZO0hTfwwiKjRaNpR2msrhkvJ44dVdwAApV97QtX1vn4,52
+eye_patch-1.0.0.dist-info/licenses/LICENSE,sha256=_jZTapMIOcgi0WpoRQsrKqfiwecDD_c2I9ZI93GQUUE,1497
+eye_patch-1.0.0.dist-info/RECORD,,

eye_patch-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

eye_patch-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+eye-patch = eye_patch.masking:cli

eye_patch-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, flint-crew
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.