psimager 0.2__tar.gz → 0.3__tar.gz

{psimager-0.2 → psimager-0.3}/PKG-INFO

@@ -1,17 +1,18 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: psimager
-Version: 0.2
+Version: 0.3
 Summary: Fast dirty imaging of measurement sets for power spectrum analyses, with the ducc0 w-gridder and WSClean's options
-License: GPL-3.0-or-later
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
 Author: Florent Mertens
 Author-email: florent.mertens@gmail.com
 Requires-Python: >=3.10,<4.0
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Programming Language :: Python :: 3
 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
 Provides-Extra: dev
 Requires-Dist: astropy (>=5.0)
 Requires-Dist: click (>=8.0)
@@ -66,6 +67,8 @@ Differences with WSClean:
 
 - `-even-odd` images the even and the odd time steps in one pass, as `NAME-even-*` and
   `NAME-odd-*`.
+- `-fits-keyword KEY=VALUE` (repeatable) adds a header keyword to every output file, written
+  with the file instead of updating it afterwards.
 - `-parallel-gridding` defaults to `-j`: one thread per output channel, which is the fastest.
 - No deconvolution and no `-MFS-` images.
 - WSClean's gridding options (`-oversampling`, `-kernel-size`, `-nwlayers`, `-grid-mode`,

{psimager-0.2 → psimager-0.3}/README.md

@@ -38,6 +38,8 @@ Differences with WSClean:
 
 - `-even-odd` images the even and the odd time steps in one pass, as `NAME-even-*` and
   `NAME-odd-*`.
+- `-fits-keyword KEY=VALUE` (repeatable) adds a header keyword to every output file, written
+  with the file instead of updating it afterwards.
 - `-parallel-gridding` defaults to `-j`: one thread per output channel, which is the fastest.
 - No deconvolution and no `-MFS-` images.
 - WSClean's gridding options (`-oversampling`, `-kernel-size`, `-nwlayers`, `-grid-mode`,

{psimager-0.2 → psimager-0.3}/psimager/cli.py

@@ -44,6 +44,23 @@ def parse_scale(ctx, param, text):
     return value
 
 
+def parse_keywords(ctx, param, texts):
+    """(KEY, value) of each KEY=VALUE, the value as an integer, a float or a string."""
+    keywords = []
+    for text in texts:
+        key, sep, value = text.partition('=')
+        if not sep or not re.fullmatch(r'[A-Z0-9_-]{1,8}', key.strip().upper()):
+            raise click.BadParameter(f'{text!r}: expected KEY=VALUE, KEY of at most 8 characters')
+        for cast in (int, float):
+            try:
+                value = cast(value)
+                break
+            except ValueError:
+                pass
+        keywords.append((key.strip().upper(), value))
+    return tuple(keywords)
+
+
 def ignored_options(f):
     for name, nargs in IGNORED.items():
         if nargs:
@@ -89,12 +106,14 @@ def ignored_options(f):
               '30, or -mem % of the RAM if smaller]')
 @click.option('-make-psf', is_flag=True, help='Also write the PSF.')
 @click.option('-no-dirty', is_flag=True, help='Write only the -image files.')
+@click.option('-fits-keyword', 'keywords', multiple=True, callback=parse_keywords,
+              help='Header keyword of every output file, KEY=VALUE (repeatable).')
 @click.version_option(__version__, '-version')
 @ignored_options
 def main(ms, name, data_column, pol, size, scale, channel_range, channels_out, interval,
          intervals_out, even_timesteps, odd_timesteps, even_odd, minuv_l, maxuv_l, minuvw_m,
          maxuvw_m, weight, visibility_weighting_mode, taper_edge, padding, wgridder_accuracy,
-         threads, parallel_gridding, mem, abs_mem, make_psf, no_dirty, **wsclean_options):
+         threads, parallel_gridding, mem, abs_mem, make_psf, no_dirty, keywords, **wsclean_options):
     """Dirty Stokes and PSF images of the measurement sets MS with the ducc0 w-gridder, with the
     options, file names and FITS keywords of WSClean."""
     if even_timesteps + odd_timesteps + even_odd > 1:
@@ -113,7 +132,8 @@ def main(ms, name, data_column, pol, size, scale, channel_range, channels_out, i
             minuvw_m=minuvw_m, maxuvw_m=maxuvw_m, weight=mode, robust=float(robust or 0),
             visibility_weighting=visibility_weighting_mode, taper_edge=taper_edge, padding=padding,
             epsilon=wgridder_accuracy, threads=threads, parallel_gridding=parallel_gridding,
-            mem_percent=mem, abs_mem_gb=abs_mem, make_psf=make_psf, write_dirty=not no_dirty)
+            mem_percent=mem, abs_mem_gb=abs_mem, make_psf=make_psf, write_dirty=not no_dirty,
+            keywords=keywords)
         imager = Imager(ms, settings, log=click.echo)
         start = time.time()
         paths = imager.run()

{psimager-0.2 → psimager-0.3}/psimager/imager.py

@@ -62,6 +62,7 @@ class Settings:
     abs_mem_gb: float = None
     make_psf: bool = False
     write_dirty: bool = True
+    keywords: tuple = ()                # extra (KEY, value) header cards of every file
 
     def __post_init__(self):
         self.pols = self.pols.upper()
@@ -469,6 +470,7 @@ class Imager:
                   'WSCCHANS': self.chans[0], 'WSCCHANE': self.chans[1], 'WSCNVIS': nvis,
                   'WSCENVIS': wsum ** 2 / w2sum if w2sum > 0 else 0., 'WSCVWSUM': vwsum,
                   'WSCIMGWG': imgwsum, 'WSCNORMF': wsum, 'PSIVERSI': __version__})
+        h.update(dict(s.keywords))
         return h
 
     def weight_name(self):

{psimager-0.2 → psimager-0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [project]
 name = "psimager"
-version = "0.2"
+version = "0.3"
 description = "Fast dirty imaging of measurement sets for power spectrum analyses, with the ducc0 w-gridder and WSClean's options"
 readme = "README.md"
 license = "GPL-3.0-or-later"