Evoked Response Detection
A python package and docker application for the automatic detection of evoked responses in SPES/CCEP data
Python Usage
- First install ERdetect, in the command-line run:
pip install erdetect
- To run:
- a) With a graphical user interface:
python -m erdetect ~/bids_data ~/output/ --gui
- b) From the commandline:
python -m erdetect ~/bids_data ~/output/ [--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]]
- c) To process a subset directly in a python script:
import erdetect
erdetect.process_subset('/bids_data_root/subj-01/ieeg/sub-01_run-06.edf', '/output_path/')
Docker Usage
To launch an instance of the container and analyse data in BIDS format, in the command-line interface/terminal:
docker run multimodalneuro/erdetect <bids_dir>:/data <output_dir>:/output [--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]]
For example, to run an analysis, type:
docker run -ti --rm \
-v /local_bids_data_root/:/data \
-v /local_output_path/:/output \
multimodalneuro/erdetect /data /output --participant_label 01
Configuration & Documentation
General documentation can be found here.
The tool can be configured by three means:
- Graphical User Interface (GUI)
- Command-line, arguments and options can be found here
- JSON input configuration file, usage documentation can be found here
Acknowledgements
-
Written by Max van den Boom (Multimodal Neuroimaging Lab, Mayo Clinic, Rochester MN)
-
Deviation from baseline method by Dorien van Blooijs & Dora Hermes (2018), with optimized parameters by Jaap van der Aar
-
Adapted the peak-finder algorithm by Nathanael Yoder, see Matlab version.
-
Dependencies:
- IeegPrep (https://github.com/MultimodalNeuroimagingLab/ieegprep)
- BIDS-validator (https://github.com/bids-standard/bids-validator)
- NumPy
- SciPy
- Matplotlib
-
This project was funded by the National Institute Of Mental Health of the National Institutes of Health Award Number R01MH122258 to Dora Hermes
Metadata
Release files for erdetect 2.6.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| erdetect-2.6.2.tar.gz | 65.6 kB | Without provenance | Details for erdetect-2.6.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| erdetect-2.6.2-py3-none-any.whl | Python 3 | none | any | Details for erdetect-2.6.2-py3-none-any.whl |
Total release size: 136.0 kB
Release files / erdetect-2.6.2.tar.gz
| Download URL | erdetect-2.6.2.tar.gz |
|---|---|
| Size | 65.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9963ea1aa80bf46f3ea0de400edde773f6b3e70ac43a27b0ef93905f135744ef
|
|
BLAKE2b-256 checksum How to use checksums |
ae6d4f3f26fc4c6e6b8883f5540a878bf9597bc9585c07e9509c553eb6ee8ead
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / erdetect-2.6.2-py3-none-any.whl
| Download URL | erdetect-2.6.2-py3-none-any.whl |
|---|---|
| Size | 70.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8bd0f8746c51f07120a64888e6f2d81cd417706924674cdb5fa2125ec7f2c840
|
|
BLAKE2b-256 checksum How to use checksums |
5866441ff4e0c13172354528b49dd05a3bdcce9822317a2e9c5d341479a90a54
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Security for erdetect 2.6.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.