Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antoinelame/gazetracking
👀 Eye Tracking library easily implementable to your projects
https://github.com/antoinelame/gazetracking
eye-tracking gaze-tracking opencv python
Last synced: 29 days ago
JSON representation
👀 Eye Tracking library easily implementable to your projects
- Host: GitHub
- URL: https://github.com/antoinelame/gazetracking
- Owner: antoinelame
- License: mit
- Created: 2019-02-09T22:27:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T14:58:06.000Z (4 months ago)
- Last Synced: 2024-10-14T10:43:00.562Z (29 days ago)
- Topics: eye-tracking, gaze-tracking, opencv, python
- Language: Python
- Homepage:
- Size: 67.4 MB
- Stars: 1,996
- Watchers: 43
- Forks: 528
- Open Issues: 53
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gaze Tracking
[](https://github.com/antoinelame/GazeTracking/stargazers)
This is a Python (2 and 3) library that provides a **webcam-based eye tracking system**. It gives you the exact position of the pupils and the gaze direction, in real time.
[](https://youtu.be/YEZMk1P0-yw)
_🚀 Quick note: I'm looking for job opportunities as a software developer, for exciting projects in ambitious companies. Anywhere in the world. Send me an email!_
## Installation
Clone this project:
```shell
git clone https://github.com/antoinelame/GazeTracking.git
```
### For Pip install
Install these dependencies (NumPy, OpenCV, Dlib):
```shell
pip install -r requirements.txt
```
> The Dlib library has four primary prerequisites: Boost, Boost.Python, CMake and X11/XQuartx. If you doesn't have them, you can [read this article](https://www.pyimagesearch.com/2017/03/27/how-to-install-dlib/) to know how to easily install them.
### For Anaconda install
Install these dependencies (NumPy, OpenCV, Dlib):
```shell
conda env create --file environment.yml
#After creating environment, activate it
conda activate GazeTracking
```
### Verify Installation
Run the demo:
```shell
python example.py
```
## Simple Demo
```python
import cv2
from gaze_tracking import GazeTracking
gaze = GazeTracking()
webcam = cv2.VideoCapture(0)
while True:
_, frame = webcam.read()
gaze.refresh(frame)
new_frame = gaze.annotated_frame()
text = ""
if gaze.is_right():
text = "Looking right"
elif gaze.is_left():
text = "Looking left"
elif gaze.is_center():
text = "Looking center"
cv2.putText(new_frame, text, (60, 60), cv2.FONT_HERSHEY_DUPLEX, 2, (255, 0, 0), 2)
cv2.imshow("Demo", new_frame)
if cv2.waitKey(1) == 27:
break
```
## Documentation
In the following examples, `gaze` refers to an instance of the `GazeTracking` class.
### Refresh the frame
```python
gaze.refresh(frame)
```
Pass the frame to analyze (numpy.ndarray). If you want to work with a video stream, you need to put this instruction in a loop, like the example above.
### Position of the left pupil
```python
gaze.pupil_left_coords()
```
Returns the coordinates (x,y) of the left pupil.
### Position of the right pupil
```python
gaze.pupil_right_coords()
```
Returns the coordinates (x,y) of the right pupil.
### Looking to the left
```python
gaze.is_left()
```
Returns `True` if the user is looking to the left.
### Looking to the right
```python
gaze.is_right()
```
Returns `True` if the user is looking to the right.
### Looking at the center
```python
gaze.is_center()
```
Returns `True` if the user is looking at the center.
### Horizontal direction of the gaze
```python
ratio = gaze.horizontal_ratio()
```
Returns a number between 0.0 and 1.0 that indicates the horizontal direction of the gaze. The extreme right is 0.0, the center is 0.5 and the extreme left is 1.0.
### Vertical direction of the gaze
```python
ratio = gaze.vertical_ratio()
```
Returns a number between 0.0 and 1.0 that indicates the vertical direction of the gaze. The extreme top is 0.0, the center is 0.5 and the extreme bottom is 1.0.
### Blinking
```python
gaze.is_blinking()
```
Returns `True` if the user's eyes are closed.
### Webcam frame
```python
frame = gaze.annotated_frame()
```
Returns the main frame with pupils highlighted.
## You want to help?
Your suggestions, bugs reports and pull requests are welcome and appreciated. You can also starring ⭐️ the project!
If the detection of your pupils is not completely optimal, you can send me a video sample of you looking in different directions. I would use it to improve the algorithm.
## Licensing
This project is released by Antoine Lamé under the terms of the MIT Open Source License. View LICENSE for more information.