Metadata-Version: 2.1
Name: Fringes-GUI
Version: 1.0.0
Summary: Graphical user interface for the 'fringes' package.
Home-page: https://github.com/comimag/fringes-gui
License: CC-BY-NC-SA-4.0
Keywords: phase shifting,phase unwrapping,fringe analysis,fringe projection,deflectometry,computational imaging
Author: Christian Kludt
Requires-Python: >=3.10,<3.13
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Dist: asdf (>=3.0.1,<4.0.0)
Requires-Dist: fringes (>=1.1,<1.2)
Requires-Dist: h5py (>=3.9.0,<4.0.0)
Requires-Dist: numpy (>=1.26.1,<2.0.0)
Requires-Dist: opencv-contrib-python (>=4.7.0,<5.0.0)
Requires-Dist: pyqt6 (>=6.4.2,<7.0.0)
Requires-Dist: pyqtgraph (>=0.13.2,<0.14.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface
Project-URL: Repository, https://github.com/comimag/fringes-gui
Description-Content-Type: text/markdown

# Fringes-GUI
![PyPI](https://img.shields.io/pypi/v/fringes-gui)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fringes-gui)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Read the Docs](https://img.shields.io/readthedocs/fringes)](https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface)
![PyPI - License](https://img.shields.io/pypi/l/fringes-gui)
[![Static Badge](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.10936353-blue)](https://zenodo.org/doi/10.5281/zenodo.10936353)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/fringes-gui)](https://pypistats.org/packages/fringes-gui)

<!---
[![Downloads](https://static.pepy.tech/badge/fringes-gui)](https://pepy.tech/project/fringes-gui)
--->

Graphical user interface for the [fringes](https://pypi.org/project/fringes/) package.

## Installation
You can install `fringes-gui` directly from [PyPi](https://pypi.org/project/fringes-gui) via `pip`:

```
pip install fringes-gui
```

## Usage
You import the `fringes-gui` package and call the function `run()`.

```python
import fringes_gui as fgui

fgui.run()
```

Now the graphical user interface should appear:

![Screenshot](https://raw.githubusercontent.com/comimag/fringes/main/docs/getting_started/GUI.png)\
Screenshot of the GUI.

## Documentation
The documentation can be found here:
[Fringes - Graphical User Interface](https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface)

## License
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License

## Support
I was looking for a user-friendly tool to configure,
encode and decode customized fringe patterns with phase shifting algorithms.
Since I couldn't find any, I started developing one myself.
It is intended for [non-commercial](#license), academic and educational use.

However, I do this entirely in my free time.
If you like this package and can make use of it, I would be happy about a donation.
It will help me keep it up-to-date and adding more features in the future.

<!---
[![Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/comimag/donate/)
[![](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EHBGZ229DKUC4)
--->

[![paypal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=PayPal&logoColor=white)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EHBGZ229DKUC4)

Thank you!

