Metadata-Version: 2.4
Name: pupil-labs-marker-mapper
Version: 1.0.0
Summary: Marker Mapper
Project-URL: Homepage, https://pupil-labs.github.io/pl-marker-mapper
Project-URL: Documentation, https://pupil-labs.github.io/pl-marker-mapper
Project-URL: Repository, https://github.com/pupil-labs/pl-marker-mapper
Project-URL: Issues, https://github.com/pupil-labs/pl-marker-mapper/issues
Author-email: Pupil Labs GmbH <info@pupil-labs.com>
License: MIT
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: <4.0,>=3.10
Requires-Dist: numpy
Requires-Dist: opencv-python>=4.11.0.86
Requires-Dist: pupil-apriltags>=1.0.4.post11
Requires-Dist: pupil-labs-camera
Requires-Dist: pupil-labs-neon-recording>=1.0.3
Provides-Extra: examples
Requires-Dist: opencv-python>=4.11.0.86; extra == 'examples'
Requires-Dist: pupil-labs-realtime-api>=1.6.2; extra == 'examples'
Requires-Dist: pyside6>=6.9.1; extra == 'examples'
Description-Content-Type: text/markdown

# Pupil Labs Marker Mapper

[![ci](https://github.com/pupil-labs/pl-marker-mapper/actions/workflows/main.yml/badge.svg)](https://github.com/pupil-labs/pl-marker-mapper/actions/workflows/main.yml)
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pupil-labs.github.io/pl-marker-mapper/)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![pre-commit](https://img.shields.io/badge/pre_commit-black?logo=pre-commit&logoColor=FAB041)](https://github.com/pre-commit/pre-commit)
[![pypi version](https://img.shields.io/pypi/v/pupil-labs-marker-mapper.svg)](https://pypi.org/project/pupil-labs-marker-mapper/)
[![python version](https://img.shields.io/pypi/pyversions/pupil-labs-marker-mapper)](https://pypi.org/project/pupil-labs-marker-mapper/)


This is an implementation of the Marker Mapper functionality as it can be found in e.g. [Pupil Cloud](https://cloud.pupil-labs.com/) and [Neon Player](https://docs.pupil-labs.com/neon/neon-player/). This implementation allows both post hoc and real-time gaze mapping onto surfaces defined by AprilTags.

The examples demonstrate how to interact with the Marker Mapper's interface. There is also an example app that demonstrates the Marker Mapper functionality in real-time in combination with a Neon device.

## Installation

```bash
pip install -e git+https://github.com/pupil-labs/pl-marker-mapper.git
```
