Metadata-Version: 2.1
Name: regularizepsf
Version: 0.2.3
Summary: Point spread function modeling and regularization
Home-page: https://github.com/punch-mission/regularizepsf
Author: J. Marcus Hughes
Author-email: hughes.jmb@gmail.com
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: dill
Requires-Dist: h5py
Requires-Dist: lmfit
Requires-Dist: sep
Requires-Dist: cython
Requires-Dist: astropy
Requires-Dist: scipy
Requires-Dist: scikit-image
Requires-Dist: matplotlib
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: pytest-runner; extra == "test"
Requires-Dist: pytest-mpl; extra == "test"

# regularizepsf
[![codecov](https://codecov.io/gh/punch-mission/regularizepsf/branch/main/graph/badge.svg?token=pn4NTO70I9)](https://codecov.io/gh/punch-mission/regularizepsf)
[![DOI](https://zenodo.org/badge/555583385.svg)](https://zenodo.org/badge/latestdoi/555583385)
[![PyPI version](https://badge.fury.io/py/regularizepsf.svg)](https://badge.fury.io/py/regularizepsf)
[![CI](https://github.com/punch-mission/regularizepsf/actions/workflows/ci.yml/badge.svg)](https://github.com/punch-mission/regularizepsf/actions/workflows/ci.yml)

A package for manipulating and correcting variable point spread functions.

Below is an example of correcting model data using the package. An initial image of a simplified starfield (a) is synthetically observed with a slowly
varying PSF (b), then regularized with this technique (c). The final image visually matches a direct convolution of
the initial image with the target PSF (d). The panels are gamma-corrected to highlight the periphery of the model PSFs.
![Example result image](model_example.png)

## Getting started

`pip install regularizepsf` and then follow along with the [Quickstart section](https://punch-mission.github.io/regularizepsf/quickstart.html). 

## Contributing
We encourage all contributions. If you have a problem with the code or would like to see a new feature, please open an issue. Or you can submit a pull request. 

## License
See LICENSE for the MIT license

## Need help?
Please contact Marcus Hughes at [marcus.hughes@swri.org](mailto:marcus.hughes@swri.org).

## Citation
Please cite the associated paper if you use this technique: 

```
@article{Hughes_2023,
doi = {10.3847/1538-3881/acc578},
url = {https://dx.doi.org/10.3847/1538-3881/acc578},
year = {2023},
month = {apr},
publisher = {The American Astronomical Society},
volume = {165},
number = {5},
pages = {204},
author = {J. Marcus Hughes and Craig E. DeForest and Daniel B. Seaton},
title = {Coma Off It: Regularizing Variable Point-spread Functions},
journal = {The Astronomical Journal}
}
```

If you use this software, please also cite the package: 
```
@software{marcus_hughes_2023_8370994,
  author       = {Marcus Hughes and
                  Sam Van Kooten and
                  Tania Varesano and
                  Suman Chapai},
  title        = {punch-mission/regularizepsf: 0.2.2},
  month        = sep,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {0.2.2},
  doi          = {10.5281/zenodo.8370994},
  url          = {https://doi.org/10.5281/zenodo.8370994}
}
```
