Skip to main content

Pupil detectors

Project description

pupil-detectors

PyPI

This is a python-package containing standalone pupil detectors for the Pupil-Labs software stack. It contains the following detectors:

  • Detector2D
  • Detector3D

Installation

macOS and Linux

This package has a couple of non-python dependencies that you will have to install yourself before you can install pupil-detectors. We are working on clean setup instructions, but until then you can just install all dependencies from the Pupil software stack. You can find installation guides on the Pupil GitHub page (section: Installing Dependencies).

Then you can install pupil-detectors with pip:

pip install pupil-detectors

Windows

Since the dependency setup is very complex on Windows, we provide prebuilt-wheels. This means you don't have to install any dependencies and can just install pupil-detectors:

pip install pupil-detectors

If you don't want to use our prebuilt versions, see the section Building from Source further below.

Usage

Here's a quick example on how to detect and draw an ellipse.

import cv2
from pupil_detectors import Detector2D, Detector3D

detector = Detector2D()

# read image as numpy array from somewhere, e.g. here from a file
img = cv2.imread("pupil.png")
gray = cv2.cvtColor(img, cv2.COLOR_BGR2GRAY)

result = detector.detect(gray)
ellipse = result["ellipse"]

# draw the ellipse outline onto the input image
# note that cv2.ellipse() cannot deal with float values
# also it expects the axes to be semi-axes (half the size)
cv2.ellipse(
    img,
    tuple(int(v) for v in ellipse["center"]),
    tuple(int(v / 2) for v in ellipse["axes"]),
    ellipse["angle"],
    0, 360, # start/end angle for drawing
    (0, 0, 255) # color (BGR): red
)
cv2.imshow("Image", img)
cv2.waitKey(0)

Developers

Building from Source

You can install this package locally from source. Make sure you have all necessary dependencies setup (see Installation section above).

NOTE: For Windows the dependency setup is quite complex. Until we have clean instructions, please follow the guide for setting up Windows dependencies for Pupil.

NOTE: When building the package on your own, you can experience severe performance differences when not having setup your dependencies correctly. Make sure to compare performance to prebuilt wheels or to bundled versions of Pupil.

# Clone repository
git clone git@github.com:pupil-labs/pupil-detectors.git
cd pupil-detectors

# Install from source with development extras
pip install ".[dev]"

# Run tests
pytest tests

Maintainers

Distribution

This project does not currently support automated distribution. Steps for a new release:

  1. Make sure the code works.
  2. Install dependencies
pip install bump2version twine
  1. Create new tag with bump2version.

    • Decide on type of version bump: major/minor/patch

    • Make sure the working directory is clean! (git status)

    • Modify CHANGELOG.md to include newest version notes.

    • Stage changelog (don't commit):

      git add CHANGELOG.md

    • Run the appropriate bump2version. This will create a new commit with all necessary changes (including the staged changelog) and a new tag!

      # ONLY ONE OF THOSE!
      bump2version major --allow-dirty
      # or
      bump2version minor --allow-dirty
      # or
      bump2version patch --allow-dirty
      
  2. Push the new commit and (all) tags.

git push --tags
  1. Build the source distribution and wheel (Windows). Use the internal bundle-machine for Pupil for the correct dependency setup!
python setup.py sdist
pip wheel --no-deps . -w dist
  1. Test installing from wheel and from sdist!

  2. Upload wheel and sdist to PyPI.

twine upload ./dist/*

Changelog

1.0.5 (2020-04-20)

Added

  • Added option to run 3D detector without internal 2D detector, but from serialized data of external 2D detector

1.0.4 (2020-01-13)

Fixed

  • Fixed crash when installing from source distribution package

1.0.3 (2020-01-07)

Fixed

  • Wrong Roi.rect() computation.

1.0.2 (2019-12-03)

  • Initial release.

Project details


Download files

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

Source Distribution

pupil-detectors-1.0.5.tar.gz (399.9 kB view details)

Uploaded Source

Built Distribution

pupil_detectors-1.0.5-cp36-cp36m-win_amd64.whl (14.6 MB view details)

Uploaded CPython 3.6mWindows x86-64

File details

Details for the file pupil-detectors-1.0.5.tar.gz.

File metadata

  • Download URL: pupil-detectors-1.0.5.tar.gz
  • Upload date:
  • Size: 399.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.8

File hashes

Hashes for pupil-detectors-1.0.5.tar.gz
Algorithm Hash digest
SHA256 1e40197f666c98ebd4bd11a64ee0345f2b8546468350cbeeb5c388b4f138c146
MD5 9bd31eaef171abe47dd96196d57e20ab
BLAKE2b-256 48fb8a811dfbd84c0e3b30af8598fd0f8938a305a0488ee4248db12ed6b32340

See more details on using hashes here.

File details

Details for the file pupil_detectors-1.0.5-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: pupil_detectors-1.0.5-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 14.6 MB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.8

File hashes

Hashes for pupil_detectors-1.0.5-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 ba7fa21561e46782be2472f04d3b0ce6a766e8dccff4d9c414a1e39a89eb028c
MD5 7fb48f0c0592e990c40faf2434408868
BLAKE2b-256 754e7becadc97182a179616b6a1e0ff610abcd197cccbff6644d560809c962df

See more details on using hashes here.

Supported by

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