mirror of
https://github.com/ck-zhang/EyePy.git
synced 2026-05-05 08:59:12 -05:00
ck-zhang
84 lines
1.9 KiB
Markdown
84 lines
1.9 KiB
Markdown
# EyePy
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This is a Python library that provides **webcam-based eye tracking**.
|
|
Extract facial features, train eye tracking model and predict gaze with super easy to use interface.
|
|
|
|
## Usage Showcase
|
|
|
|
|
|
## Installation and Interactive Demo
|
|
|
|
Clone this project:
|
|
```shell
|
|
git clone https://github.com/ck-zhang/EyePy
|
|
```
|
|
|
|
### Using Pip
|
|
```shell
|
|
pip install -r requirements.txt
|
|
python demo.py
|
|
```
|
|
|
|
### Using uv
|
|
```shell
|
|
pip install uv
|
|
uv sync
|
|
uv run demo.py
|
|
```
|
|
|
|
### Options
|
|
|
|
- `--filter {kalman,kde}`: Filter method; `kalman` for Kalman Filter, or `kde` for a cool contour like in the demo
|
|
- `--background BACKGROUND`: Path to background image file
|
|
- `--confidence CONFIDENCE`: Set confidence interval for KDE contour; value must be between 0 and 1
|
|
- `--camera CAMERA`: Specify camera index
|
|
|
|
|
|
## Usage
|
|
|
|
### Initialization
|
|
```python
|
|
from EyePy import GazeEstimator
|
|
gaze_estimator = GazeEstimator()
|
|
```
|
|
|
|
### Feature Extraction
|
|
```python
|
|
import cv2
|
|
image = cv2.imread('image.jpg')
|
|
features, blink_detected = gaze_estimator.extract_features(image)
|
|
if blink_detected:
|
|
print("Blink detected!")
|
|
else:
|
|
print(features)
|
|
```
|
|
|
|
### Training the Model
|
|
```python
|
|
X = [...] # Features
|
|
y = [...] # Gaze coordinates
|
|
gaze_estimator.train(X, y)
|
|
```
|
|
|
|
### Predicting Gaze Location
|
|
```python
|
|
predicted_gaze = gaze_estimator.predict([features])
|
|
print(predicted_gaze)
|
|
```
|
|
|
|
## Future Work
|
|
|
|
### TODO
|
|
|
|
- [ ] Integrate with OBS
|
|
- [ ] Integrate with opentrack
|
|
|
|
Any suggestions for features and improvements are welcome.
|
|
|
|
If you enjoyed using EyePy, consider giving it a star.
|