Metadata-Version: 2.1
Name: cheshm
Version: 1.0.0
Summary: Pupil, glint, and limbus detection on grayscale eye images, plus iris-texture rigid alignment of two eye images.
Keywords: eye-tracking,iris-detection,pupil-detection,glint-detection,limbus-detection,daugman,image-alignment,image-processing
Author-Email: Mohammadhossein Salari <mohammadhossein.salari@gmail.com>
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: C
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
Project-URL: Homepage, https://github.com/mh-salari/cheshm
Project-URL: Repository, https://github.com/mh-salari/cheshm
Project-URL: Issues, https://github.com/mh-salari/cheshm/issues
Requires-Python: >=3.10
Requires-Dist: dearpygui
Requires-Dist: numba
Requires-Dist: numpy
Requires-Dist: opencv-python
Requires-Dist: pyobjc-framework-Cocoa; sys_platform == "darwin"
Provides-Extra: dev
Requires-Dist: ruff>=0.15.13; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pyinstaller>=6.0; extra == "dev"
Description-Content-Type: text/markdown

# <img src="src/cheshm/gui/icon.png" alt="" width="48"> `cheshm`

[![PyPI version](https://img.shields.io/pypi/v/cheshm)](https://pypi.org/project/cheshm/)
[![Downloads](https://static.pepy.tech/badge/cheshm)](https://pepy.tech/project/cheshm)
[![License](https://img.shields.io/pypi/l/cheshm)](https://github.com/mh-salari/cheshm/blob/main/LICENSE)
[![DOI](https://zenodo.org/badge/1242928603.svg)](https://doi.org/10.5281/zenodo.20293526)


## Single-eye contract

Every public function in cheshm operates on **one eye at a time** — a single grayscale image.

## License

Cheshm's core code is MIT-licensed (see [`LICENSE`](LICENSE)). Each detector ships its own LICENSE file in its subdirectory and may carry a different licence depending on the upstream source it was ported from.

| Detector | Subdirectory | Licence |
|---|---|---|
| Daugman integro-differential operator | `src/cheshm/limbus_detectors/daugman/integro_differential/` | MIT (© 2023 Fatih BAŞATEMUR — carried from his MIT port) |
| Daugman 2007 active contour | `src/cheshm/limbus_detectors/daugman/active_contour/` | MIT |
| Pupil-shape-prior active contour | `src/cheshm/limbus_detectors/daugman/pupil_guided/` | MIT |

## Name

In Persian (Farsi), Cheshm (چشم) literally means "eye".

## Logo

The nazar / cheshm amulet image is from [pngegg](https://www.pngegg.com/en/png-klwpz).

## Acknowledgments

This work received funding from the European Union's Horizon Europe research and innovation funding program under grant agreement No 101072410, Eyes4ICU project.

<p align="center">
<img src="https://raw.githubusercontent.com/mh-salari/cheshm/main/resources/Funded_by_EU_Eyes4ICU.png" alt="Funded by EU Eyes4ICU" width="500">
</p>
