weightmask 0.1.0__tar.gz

weightmask-0.1.0/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.0 - 2026-09-08
+
+First tagged release of the classical weightmask pipeline (`pip install weightmask`).
+
+- CLI: `weightmask` (MEF-capable) and `weightmask-reconstruct-sky`
+- Products: weight or confidence, quality mask, inverse-variance, sky, optional per-contaminant masks
+- Quality bits: BAD, SAT, CR, DETECTED, STREAK, INVALID_VARIANCE (`set_means_flagged`)
+- Theoretical core plane is an Elixir-style F² sensitivity weight `g² F² / (S g + RN²)` (Poisson+RN at F=1). Canonical YAML also enables `flat_rel_noise` and `rescale_variance`.
+- Sky mesh encode/decode uses the same clipped SEP node abscissae
+- Config: canonical `weightmask.yml`; unknown top-level keys rejected; `WeightMapGenerator` fails closed
+
+Known limitations: one gain/readnoise per HDU; real-data benchmark suites need external labels.

weightmask-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sébastien Fabbro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

weightmask-0.1.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include CHANGELOG.md
+include weightmask.yml
+prune tests
+prune examples
+prune benchmarks
+prune sandbox

weightmask-0.1.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: weightmask
+Version: 0.1.0
+Summary: Per-pixel weight, mask, inverse-variance, and sky maps for astronomical FITS images.
+Author-email: Seb Fabbro <sebfabbro@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/astroai/weightmask
+Project-URL: Issues, https://github.com/astroai/weightmask/issues
+Project-URL: Changelog, https://github.com/astroai/weightmask/blob/main/CHANGELOG.md
+Project-URL: Source, https://github.com/astroai/weightmask
+Project-URL: PyPI, https://pypi.org/project/weightmask/
+Keywords: astronomy,FITS,weight,mask,variance
+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: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: astropy
+Requires-Dist: fitsio
+Requires-Dist: scipy
+Requires-Dist: scikit-image
+Requires-Dist: sep
+Requires-Dist: PyYAML
+Requires-Dist: astroscrappy
+Dynamic: license-file
+
+# weightmask
+
+[![CI](https://github.com/astroai/weightmask/actions/workflows/ci.yml/badge.svg)](https://github.com/astroai/weightmask/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/weightmask.svg)](https://pypi.org/project/weightmask/)
+[![Python](https://img.shields.io/pypi/pyversions/weightmask.svg)](https://pypi.org/project/weightmask/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+weightmask reads a detrended FITS or MEF science image and writes a per-pixel
+weight, quality mask, inverse-variance map, and sky.
+
+Those products are for any measurement that should ignore bad pixels and
+down-weight the rest: coaddition, shape measurement, forced photometry,
+profile fitting, and difference imaging.
+
+## Install
+
+```bash
+pip install weightmask
+```
+
+Python 3.10+. Copy [`weightmask.yml`](weightmask.yml) into the working directory;
+it is not bundled in the wheel.
+
+Pixi (development):
+
+```bash
+git clone https://github.com/astroai/weightmask.git
+cd weightmask
+pixi install
+```
+
+Details: [docs/installation.md](docs/installation.md).
+
+## Run
+
+```bash
+weightmask science.fits --config weightmask.yml --flat_image flat.fits \
+  -o weight.fits --output_mask mask.fits
+```
+
+## Docs
+
+- [Installation](docs/installation.md)
+- [Usage](docs/usage.md)
+- [Algorithms](docs/algorithms.md)
+- [API](docs/api.md)
+- [CHANGELOG](CHANGELOG.md)
+
+## License
+
+MIT

weightmask-0.1.0/README.md

@@ -0,0 +1,51 @@
+# weightmask
+
+[![CI](https://github.com/astroai/weightmask/actions/workflows/ci.yml/badge.svg)](https://github.com/astroai/weightmask/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/weightmask.svg)](https://pypi.org/project/weightmask/)
+[![Python](https://img.shields.io/pypi/pyversions/weightmask.svg)](https://pypi.org/project/weightmask/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+weightmask reads a detrended FITS or MEF science image and writes a per-pixel
+weight, quality mask, inverse-variance map, and sky.
+
+Those products are for any measurement that should ignore bad pixels and
+down-weight the rest: coaddition, shape measurement, forced photometry,
+profile fitting, and difference imaging.
+
+## Install
+
+```bash
+pip install weightmask
+```
+
+Python 3.10+. Copy [`weightmask.yml`](weightmask.yml) into the working directory;
+it is not bundled in the wheel.
+
+Pixi (development):
+
+```bash
+git clone https://github.com/astroai/weightmask.git
+cd weightmask
+pixi install
+```
+
+Details: [docs/installation.md](docs/installation.md).
+
+## Run
+
+```bash
+weightmask science.fits --config weightmask.yml --flat_image flat.fits \
+  -o weight.fits --output_mask mask.fits
+```
+
+## Docs
+
+- [Installation](docs/installation.md)
+- [Usage](docs/usage.md)
+- [Algorithms](docs/algorithms.md)
+- [API](docs/api.md)
+- [CHANGELOG](CHANGELOG.md)
+
+## License
+
+MIT

weightmask-0.1.0/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "weightmask"
+version = "0.1.0"
+authors = [
+  { name="Seb Fabbro", email="sebfabbro@gmail.com" },
+]
+description = "Per-pixel weight, mask, inverse-variance, and sky maps for astronomical FITS images."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+keywords = ["astronomy", "FITS", "weight", "mask", "variance"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Astronomy",
+]
+dependencies = [
+    "numpy",
+    "astropy",
+    "fitsio",
+    "scipy",
+    "scikit-image",
+    "sep",
+    "PyYAML",
+    "astroscrappy",
+]
+
+[project.urls]
+Homepage = "https://github.com/astroai/weightmask"
+Issues = "https://github.com/astroai/weightmask/issues"
+Changelog = "https://github.com/astroai/weightmask/blob/main/CHANGELOG.md"
+Source = "https://github.com/astroai/weightmask"
+PyPI = "https://pypi.org/project/weightmask/"
+
+[tool.setuptools.packages.find]
+include = ["weightmask"]
+exclude = ["sandbox*", "tests*", "examples*", "benchmarks*"]
+
+# --- This section creates the command-line script ---
+[project.scripts]
+weightmask = "weightmask.cli:run_pipeline"
+weightmask-reconstruct-sky = "weightmask.reconstruct_sky:main"
+
+[tool.ruff]
+line-length = 120
+extend-exclude = ["benchmarks"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]
+ignore = ["E501"]

weightmask-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

weightmask-0.1.0/weightmask/__init__.py

@@ -0,0 +1,36 @@
+"""
+WeightMask: A modular tool for generating mask, weight, and confidence maps for astronomical images.
+
+This package includes modules for detecting various effects in astronomical images:
+- Saturation
+- Bad pixels
+- Cosmic rays
+- Streaks
+- Object detection
+- Background estimation
+- Variance calculation
+"""
+
+try:
+    from importlib.metadata import version as _distribution_version
+
+    __version__ = _distribution_version("weightmask")
+except Exception:
+    __version__ = "0.1.0"
+
+# Legacy public dictionary kept stable; the contract adds INVALID_VARIANCE.
+from .contract import QUALITY_BITS
+
+MASK_BITS = QUALITY_BITS
+
+MASK_DTYPE = "uint32"  # Data type for the bitmask
+
+__all__ = ["MASK_BITS", "MASK_DTYPE", "QUALITY_BITS", "WeightMapGenerator", "__version__"]
+
+
+def __getattr__(name: str):
+    if name == "WeightMapGenerator":
+        from .pipeline import WeightMapGenerator
+
+        return WeightMapGenerator
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")