# Fringes-GUI
[](https://github.com/psf/black)
[](https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface)
[](https://zenodo.org/doi/10.5281/zenodo.10936353)
[](https://pypistats.org/packages/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 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.
<!---
[](https://liberapay.com/comimag/donate/)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EHBGZ229DKUC4)
--->
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EHBGZ229DKUC4)
Thank you!
Raw data
{
"_id": null,
"home_page": "https://github.com/comimag/fringes-gui",
"name": "Fringes-GUI",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "phase shifting, phase unwrapping, fringe analysis, fringe projection, deflectometry, computational imaging",
"author": "Christian Kludt",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/41/d7/258192811ec7bdc87e1c5d73acd9714d895b043edde801d4680db96726d1/fringes_gui-1.0.2.tar.gz",
"platform": null,
"description": "# Fringes-GUI\n\n\n[](https://github.com/psf/black)\n[](https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface)\n\n[](https://zenodo.org/doi/10.5281/zenodo.10936353)\n[](https://pypistats.org/packages/fringes-gui)\n\n<!---\n[](https://pepy.tech/project/fringes-gui)\n--->\n\nGraphical user interface for the [fringes](https://pypi.org/project/fringes/) package.\n\n## Installation\nYou can install `fringes-gui` directly from [PyPi](https://pypi.org/project/fringes-gui) via `pip`:\n\n```\npip install fringes-gui\n```\n\n## Usage\nYou import the `fringes-gui` package and call the function `run()`.\n\n```python\nimport fringes_gui as fgui\n\nfgui.run()\n```\n\nNow the graphical user interface should appear:\n\n\\\nScreenshot of the GUI.\n\n## Documentation\nThe documentation can be found here:\n[Fringes - Graphical User Interface](https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface)\n\n## License\nCreative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License\n\n## Support\nI was looking for a user-friendly tool to configure,\nencode and decode customized fringe patterns with phase shifting algorithms.\nSince I couldn't find any, I started developing one myself.\nIt is intended for [non-commercial](#license), academic and educational use.\n\nHowever, I do this entirely in my free time.\nIf you like this package and can make use of it, I would be happy about a donation.\nIt will help me keep it up-to-date and adding more features in the future.\n\n<!---\n[](https://liberapay.com/comimag/donate/)\n[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EHBGZ229DKUC4)\n--->\n\n[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EHBGZ229DKUC4)\n\nThank you!\n",
"bugtrack_url": null,
"license": "CC-BY-NC-SA-4.0",
"summary": "Graphical user interface for the 'fringes' package.",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://fringes.readthedocs.io/en/latest/getting_started/usage.html#graphical-user-interface",
"Homepage": "https://github.com/comimag/fringes-gui",
"Repository": "https://github.com/comimag/fringes-gui"
},
"split_keywords": [
"phase shifting",
" phase unwrapping",
" fringe analysis",
" fringe projection",
" deflectometry",
" computational imaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82b24d36127a475cf26e8a5cc70883c9851d0b303f02fd4bb04bbea77375ec6b",
"md5": "5e0d8e4686aef6e152ce389ca38481f1",
"sha256": "f666d3c19f28d5d682a11c2c9e65291e0ce413777c4c6115996ed02b4cfd2e0c"
},
"downloads": -1,
"filename": "fringes_gui-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e0d8e4686aef6e152ce389ca38481f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 32303,
"upload_time": "2024-04-28T12:29:50",
"upload_time_iso_8601": "2024-04-28T12:29:50.017436Z",
"url": "https://files.pythonhosted.org/packages/82/b2/4d36127a475cf26e8a5cc70883c9851d0b303f02fd4bb04bbea77375ec6b/fringes_gui-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41d7258192811ec7bdc87e1c5d73acd9714d895b043edde801d4680db96726d1",
"md5": "316b97c39cf39d2abcb44fdad6a9e339",
"sha256": "e9b766f912fe82f04cedbef1d643012d0bdbdbf74fe1a4e057ab059c223921b9"
},
"downloads": -1,
"filename": "fringes_gui-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "316b97c39cf39d2abcb44fdad6a9e339",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 30101,
"upload_time": "2024-04-28T12:29:51",
"upload_time_iso_8601": "2024-04-28T12:29:51.720754Z",
"url": "https://files.pythonhosted.org/packages/41/d7/258192811ec7bdc87e1c5d73acd9714d895b043edde801d4680db96726d1/fringes_gui-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 12:29:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "comimag",
"github_project": "fringes-gui",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fringes-gui"
}
JSON
