Skip to main content

automatic-spike-detection

The automatic-spike-detection package is a Python library for automatically detecting interictal epileptiform discharges (IEDs) in intracranial EEG (iEEG) recordings.

IEDs, also referred to as ”spikes”, are a characteristic of the epileptic brain that are recognizable as large transient events in the electroencephalogram of patients living with epilepsy [1]. Whereas, for clinicians, IEDs can provide valuable information about the epileptogenic zone, for researchers, they can also be a source of noise and need to be excluded, such as in [2] where Cusinato and Alnes et al. studied how the human brain processes sounds. Regardless of the context, the localization of IEDs in EEG recordings is a very time-consuming task.

This package aims to contribute to this issue by building on an algorithm previously developed by Baud et al. [3] that employs nonnegative matrix factorization (NMF) to automatically detect IEDs, an unsupervised machine-learning algorithm that produces a lower-dimensional approximation of the input.

It is important to note, that the algorithm used by this package is optimized for and was solely tested on iEEG recordings. Intracranial EEG is an invasive technique with implanted electrodes that is used for clinical monitoring, e.g. to identify the epileptogenic zone and prepare for epilepsy surgery. The primary characteristic of iEEG is that it provides high spatial and temporal resolution of the electrical activity in the brain, which makes it a valuable resource for neuroscientific research as well [4].

Please consult the automatic-spike-detection Documentation for details on the underlying concepts of the algorithm, the Installation and Usage , and the application programming interface (API)

Contributions

In addition to the dependencies in the requirements.txt file, you need to install the dependencies listed in the dev-requirements.txt file, which provides some formatting tools:

pip install requirements.txt
pip install dev-requirements.txt

References

[1] Marco de Curtis and Giuliano Avanzini. "Interictal spikes in focal epileptogenesis". Progress in Neurobiology 63, no.5 (2001): 541-567.

[2] Riccardo Cusinato, Sigurd L. Alnes, Ellen van Maren, Ida Boccalaro, Debora Ledergerber, Antoine Adamantidis, Lukas L. Imbach, Kaspar Schindler, Maxime O. Baud, and Athina Tzovara. Intrinsic neural timescales in the temporal lobe support an auditory processing hierarchy. Journal of Neuroscience, 43(20):3696–3707, 2023.

[3] Maxime O. Baud, Jonathan K. Kleen, Gopala K. Anumanchipalli, Liberty S. Hamilton, Yee-Leng Tan, Robert Knowlton, and Edward F. Chang. Unsupervised learning of spatiotemporal interictal discharges in focal epilepsy. Neurosurgery, 83(4), 2018.

[4] Elizabeth L Johnson, Julia W Y Kam, Athina Tzovara, and Robert T Knight. Insights into human cognition from intracranial eeg: A review of audition, memory, internal cognition, and causality. Journal of Neural Engineering, 17(5):051001, oct 2020.

Release files for automatic-spike-detection 1.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for automatic-spike-detection 1.3.3
File Size Uploaded
automatic_spike_detection-1.3.3.tar.gz 54.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for automatic-spike-detection 1.3.3
File Interpreter ABI Platform
automatic_spike_detection-1.3.3-py3-none-any.whl Python 3 none any Details

Total release size: 113.5 kB

Release files / automatic_spike_detection-1.3.3.tar.gz

Download URL automatic_spike_detection-1.3.3.tar.gz
Size 54.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3b7e3ded5c4c00b295a1202e338738849daa22c1b019c970b32067647ca441e9
BLAKE2b-256 checksum
How to use checksums
39949de9d54fbffcac0fac6059e2b29bed2b5697b6f3e134064b452c59503d70
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / automatic_spike_detection-1.3.3-py3-none-any.whl

Download URL automatic_spike_detection-1.3.3-py3-none-any.whl
Size 59.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2e06e89f31d89fe65ee87aec7365610754dcf7ec78d2f5728a87218970c7b3c3
BLAKE2b-256 checksum
How to use checksums
b1a79eaa95b9014f11d2dacf06921323a0806ae47e00d49a57ec627f0afdf6d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page