Skip to main content

GazeFollower is a pythonic library for web-cam gaze tracking.

Project description

GazeFollower

An open-source gaze tracking system for web cameras
Simple, Fast, Pythonic, Accurate

Introduction

GazeFollower is a powerful and easy-to-use gaze tracking system designed specifically for use with web cameras. It offers an intuitive Python API, allowing developers and researchers to integrate gaze tracking into their projects with minimal setup. GazeFollower provides tools for real-time gaze tracking, calibration, and data recording, making it ideal for applications in psychology, usability testing, and more.

Features

  • Accurate Tracking: Achieves high accuracy and precision with built-in calibration methods.
  • Pythonic API: Easy-to-use, with functions for common tasks like calibration and data saving.
  • Lightweight & Fast: Optimized for real-time performance, ensuring smooth operation on most systems.
  • Experiment Ready: Includes methods for triggering and saving data, ideal for experiment-based applications.

Installation

You can install GazeFollower via pip or by cloning the repository.

Installing with pip

python -m pip install gazefollower

Git clone from Github

git clone https://github.com/GanchengZhu/GazeFollower
cd GazeFollower
python setup.py install

Quick Start

Here's a basic example of how to use GazeFollower:

# _*_ coding: utf-8 _*_

from gazefollower import GazeFollower
gaze_follower = GazeFollower()

gaze_follower.preview()
gaze_follower.calibrate()

gaze_follower.start_sampling()
# your experiment code
gaze_follower.send_trigger(10)
# your experiment code
gaze_follower.stop_sampling()
gaze_follower.save_data("demo.csv")
gaze_follower.release()

Note

This depository only contains a model train on 7 million images. To gain access to the base model trained on 32 million images, please send an email to zhiguo@zju.edu.cn. Upon successful processing of your request, you will receive an email containing the model.

Email Prompt

Here鈥檚 a template for your request email. Please keep the subject line unchanged:

Subject: Request for Access to the Base Model Trained on 32 Million Images

Dear Prof. Zhiguo,

I hope this message finds you well.

My name is [Your Name], and I am a [student/researcher] at [Your Affiliation]. I am writing to request access to the base model trained on 32 million images.

I assure you that I will use this model solely for academic and research purposes and will not utilize it for commercial activities or share it with others.

Thank you for considering my request. I look forward to receiving access to the model.

Best regards,
[Your Name]

License Information

This project is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0).

License Terms

Under the CC BY 4.0 license, you are free to:

  • Copy, distribute, display, and perform the work.
  • Remix, transform, and build upon the work, even for commercial purposes.

However, you must:

  • Attribution: You must give appropriate credit to the original author(s), provide a link to the license, and indicate if changes were made. You may do this in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

  • You may not use the material for commercial purposes unless you obtain permission from the copyright holder.

For more details, please see the full Creative Commons Attribution 4.0 International License.

Disclaimer

The work is provided "as-is" without any warranties, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, or non-infringement.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

gazefollower-0.0.2-py3-none-any.whl (11.7 MB view details)

Uploaded Python 3

File details

Details for the file gazefollower-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: gazefollower-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 11.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.11.8

File hashes

Hashes for gazefollower-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 91ad11ca524f9fb86784d334077cb16d70e7f5ecb6ca9bcb78783c08293e3139
MD5 abcdee9a5d82b15ac22770afd3260875
BLAKE2b-256 65e23daac987a69b8b1793b3c1fbffcb669b027c538c8fa360c543664caebd13

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page