| Name | eyelinkio JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A lightweight library for reading Eyelink Data Format files in Python. |
| upload_time | 2024-04-02 04:28:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
eyelink
eyetracking
neuroscience
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# EyeLinkIO
A lightweight library to import SR Research EDF files into Python.
**This Software is currenly pre-alpha, meaning it is currently being developed**: Changes to the API (function names, etc.), or even the name of this package, may occur without warning. This library has been tested with MacOS and Linux, but not Windows.
## About the Eyelink Data Format
The EyeLink Data Format (EDF; not to be confused with the [European Data Format](<https://www.edfplus.info>)) is used for storing eyetracking data from EyeLink eyetrackers. It was put forward by the company [SR Research](<https://www.sr-research.com>). SR Research EDF files store data in a binary format, and reading these files currently requires the ``eyelink-edfapi`` C library that is included in the EyeLink Software Development Kit.
## Dependencies
Strictly speaking, EyeLinkIO only requires Numpy, and that the user has the [EyeLink Software Development Kit](<https://www.sr-research.com/support/forum-3.html>) installed on their machine (One must create a login on the forum to access the download). For converting data to pandas ``DataFrames`` or MNE-Python ``Raw`` instances, you must have those respective packages installed.
## Example Usage
```python
from eyelinkio import read_edf
eyelinkio.utils import _get_test_fnames # for demonstration purposes only
fname = _get_test_fnames()[0] # Replace this function with the path to your EDF file
edf_file = read_edf(fname)
print(edf_file)
```
```bash
<EDF | test_raw.edf>
Version: EYELINK II 1
Eye: LEFT_EYE
Pupil unit: PUPIL_AREA
Sampling frequency: 1000.0 Hz
Calibrations: 1
Length: 66.827 seconds
```
```python
# Convert to a pandas DataFrame or an MNE Raw instance
dfs = edf_file.to_pandas()
raw, calibration = edf_file.to_mne()
```
See the [documentation](https://scott-huberty.github.io/eyelinkio/) for more.
## Acknowledgements
This package was originally adapted from the [pyeparse](<https://github.com/pyeparse/pyeparse>) package (created by several of the core developers of [MNE-Python](<https://mne.tools/dev/index.html>)). It copies much of the EDF (Eyelink Data Format) reading code.
## Limitations
- Reading binocular data is not yet supported
- Reading extra sample fields (velocity, HREF, head position etc.) from the EDF file is not yet supported.
See the [Roadmap](https://scott-huberty.github.io/eyelinkio/roadmap.html) for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "eyelinkio",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Scott Huberty <seh33@uw.edu>",
"keywords": "eyelink, eyetracking, neuroscience",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/dc/0e/ae472e6ae9ae737c13724c77e7f5b51b698ee4ab3119a483f60eb7b4d3cb/eyelinkio-0.1.0.tar.gz",
"platform": null,
"description": "# EyeLinkIO\n\nA lightweight library to import SR Research EDF files into Python.\n\n**This Software is currenly pre-alpha, meaning it is currently being developed**: Changes to the API (function names, etc.), or even the name of this package, may occur without warning. This library has been tested with MacOS and Linux, but not Windows.\n\n## About the Eyelink Data Format\n\nThe EyeLink Data Format (EDF; not to be confused with the [European Data Format](<https://www.edfplus.info>)) is used for storing eyetracking data from EyeLink eyetrackers. It was put forward by the company [SR Research](<https://www.sr-research.com>). SR Research EDF files store data in a binary format, and reading these files currently requires the ``eyelink-edfapi`` C library that is included in the EyeLink Software Development Kit.\n\n## Dependencies\n\nStrictly speaking, EyeLinkIO only requires Numpy, and that the user has the [EyeLink Software Development Kit](<https://www.sr-research.com/support/forum-3.html>) installed on their machine (One must create a login on the forum to access the download). For converting data to pandas ``DataFrames`` or MNE-Python ``Raw`` instances, you must have those respective packages installed.\n\n## Example Usage\n\n```python\n\nfrom eyelinkio import read_edf\neyelinkio.utils import _get_test_fnames # for demonstration purposes only\n\nfname = _get_test_fnames()[0] # Replace this function with the path to your EDF file\nedf_file = read_edf(fname)\nprint(edf_file)\n```\n\n```bash\n<EDF | test_raw.edf> \n Version: EYELINK II 1 \n Eye: LEFT_EYE \n Pupil unit: PUPIL_AREA \n Sampling frequency: 1000.0 Hz \n Calibrations: 1 \n Length: 66.827 seconds \n```\n\n```python\n# Convert to a pandas DataFrame or an MNE Raw instance\ndfs = edf_file.to_pandas()\nraw, calibration = edf_file.to_mne()\n```\n\nSee the [documentation](https://scott-huberty.github.io/eyelinkio/) for more.\n\n## Acknowledgements\n\nThis package was originally adapted from the [pyeparse](<https://github.com/pyeparse/pyeparse>) package (created by several of the core developers of [MNE-Python](<https://mne.tools/dev/index.html>)). It copies much of the EDF (Eyelink Data Format) reading code.\n\n## Limitations\n\n- Reading binocular data is not yet supported\n- Reading extra sample fields (velocity, HREF, head position etc.) from the EDF file is not yet supported.\n\nSee the [Roadmap](https://scott-huberty.github.io/eyelinkio/roadmap.html) for more details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A lightweight library for reading Eyelink Data Format files in Python.",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"eyelink",
" eyetracking",
" neuroscience"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9315c68614e4a32c6a8fc3048440b7b688123ef0bde927c7126e60de488fdf4d",
"md5": "a8ef7918d90068993cda8e7652615df5",
"sha256": "5a02d02adb78b41862d5fec1fb4ed8f986b927b52cf27c2c3019c0d39254d33c"
},
"downloads": -1,
"filename": "eyelinkio-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a8ef7918d90068993cda8e7652615df5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 19901,
"upload_time": "2024-04-02T04:28:31",
"upload_time_iso_8601": "2024-04-02T04:28:31.173036Z",
"url": "https://files.pythonhosted.org/packages/93/15/c68614e4a32c6a8fc3048440b7b688123ef0bde927c7126e60de488fdf4d/eyelinkio-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc0eae472e6ae9ae737c13724c77e7f5b51b698ee4ab3119a483f60eb7b4d3cb",
"md5": "2812ab38a4303338f22dccb54a544fa7",
"sha256": "73199db96f204c24f339659552efa4d603c61c95a551a77a16ae5e239469574f"
},
"downloads": -1,
"filename": "eyelinkio-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2812ab38a4303338f22dccb54a544fa7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 25591,
"upload_time": "2024-04-02T04:28:33",
"upload_time_iso_8601": "2024-04-02T04:28:33.369624Z",
"url": "https://files.pythonhosted.org/packages/dc/0e/ae472e6ae9ae737c13724c77e7f5b51b698ee4ab3119a483f60eb7b4d3cb/eyelinkio-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 04:28:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "eyelinkio"
}
