Metadata-Version: 2.5
Name: bioimageflow-restoration-tools
Version: 0.2.0
Summary: Restoration inference and image-quality metrics for BioImageFlow
Project-URL: Homepage, https://github.com/Inria-SAIRPICO/bioimageflow
Project-URL: Documentation, https://bioimageflow.readthedocs.io/latest/
Project-URL: Repository, https://github.com/Inria-SAIRPICO/bioimageflow
Project-URL: Issues, https://github.com/Inria-SAIRPICO/bioimageflow/issues
Author: BioImageFlow Contributors
License-Expression: BSD-4-Clause
License-File: LICENSE
Keywords: bioimage-analysis,bioimageflow,microscopy,workflow
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
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: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: >=3.10
Requires-Dist: bioimageflow-core<0.4,>=0.3.0
Requires-Dist: imageio>=2.31.0
Requires-Dist: numpy>=1.23.5
Description-Content-Type: text/markdown

# bioimageflow-restoration-tools

Tools for restoration inference, simple image-processing comparisons, and restoration metrics.

## Tools

- `CAREamicsPredict`: runs CAREamics restoration inference from a checkpoint.
- `RestorationMetrics`: computes MSE, PSNR, and residual-noise measurements.
- `TotalVariationDenoise`: applies Chambolle total-variation denoising.
- `BilateralDenoise`: applies edge-preserving bilateral denoising.
- `GaussianDenoise`: applies Gaussian smoothing as a simple denoising method.
- `MedianDenoise`: removes impulse noise with a SciPy median filter.
- `BackgroundSubtract`: subtracts a smoothed background estimate.
- `UnsharpMask`: sharpens images by adding high-frequency residuals.
- `RichardsonLucyRestoration`: runs Richardson-Lucy deconvolution.

Use the low-SNR restoration workflow in the main workflow catalog for a complete restoration example.

`RestoreImage` was removed in favor of the dedicated `TotalVariationDenoise`, `BilateralDenoise`, `GaussianDenoise`, and `UnsharpMask` tools.
`BackgroundSubtract.preserve_range` was renamed to `shift_to_zero` because it shifts the minimum to zero rather than preserving the original range.
