Metadata-Version: 2.1
Name: pupil-labs-dynamic-rim
Version: 1.0.4
Summary: A project to remap gaze on a sub ROI/AOI in the reference image mapping, to be used with displays with dynamic content.
Home-page: https://github.com/pupil-labs/dynamic-rim-module
Author: Pupil Labs GmbH
Author-email: info@pupil-labs.com
License: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Pillow
Requires-Dist: av
Requires-Dist: numpy
Requires-Dist: opencv-python
Requires-Dist: pandas
Requires-Dist: rich
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: docs
Requires-Dist: jaraco.packaging (>=9) ; extra == 'docs'
Requires-Dist: rst.linker (>=1.9) ; extra == 'docs'
Requires-Dist: sphinx ; extra == 'docs'
Provides-Extra: testing
Requires-Dist: pytest (>=6) ; extra == 'testing'
Requires-Dist: pytest-checkdocs (>=2.4) ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: pytest-enabler (>=1.3) ; extra == 'testing'
Requires-Dist: pytest-mypy (>=0.9.1) ; (platform_python_implementation != "PyPy") and extra == 'testing'

.. image:: https://img.shields.io/pypi/v/pupil-labs-dynamic-rim.svg
   :target: `PyPI link`_

.. image:: https://img.shields.io/pypi/pyversions/pupil-labs-dynamic-rim.svg
   :target: `PyPI link`_

.. _PyPI link: https://pypi.org/project/pupil-labs-dynamic-rim/

.. image:: https://github.com/pupil-labs/dynamic-rim-module/workflows/tests/badge.svg
   :target: https://github.com/pupil-labs/dynamic-rim-module/actions?query=workflow%3A%22tests%22
   :alt: tests

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
   :alt: Code style: Black

.. .. image:: https://readthedocs.org/projects/skeleton/badge/?version=latest
..    :target: https://skeleton.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/skeleton-2022-informational
   :target: https://blog.jaraco.com/skeleton

This package allows you to use the Dynamic RIM module in Pupil Labs.

This is an extension of our `RIM <https://docs.pupil-labs.com/invisible/explainers/enrichments/#reference-image-mapper>`__
enrichment that allows you to select a screen/display in the reference image and plot the gaze over the content displayed on it.
It will also give you a csv file with the coordinates of the gaze in the screen coordinates.

To install it, use:

..  code-block:: python

    pip install pupil-labs-dynamic-rim

To run it:

..  code-block:: python

    pl-dynamic-rim

See our `docs <https://docs.pupil-labs.com/>`__ for more information.
