ssp_detector
Sleep Spindles Detector toolbox analyses raw EEG signals to then extrapolate the number of sleep spindles using either the absolute or relative Sigma power (11-16Hz).
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.7%) to scientific vocabulary
Repository
Sleep Spindles Detector toolbox analyses raw EEG signals to then extrapolate the number of sleep spindles using either the absolute or relative Sigma power (11-16Hz).
Basic Info
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
- Releases: 0
Metadata Files
README.md
Sleep Spindles Detector
Sleep Spindles Detector toolbox analyses raw EEG signals to then extrapolate the number of sleep spindles using either the absolute or relative Sigma power (11-16Hz).
The toolbox is optimised for Python 3.10 and above and was tested on both Windows and macOS ARM.
[!NOTE] All dependencies are listed in requirements, Python 3.10 minimum.
Citation 
If you use this toolbox, please cite as followed:
- Guillot, S.J.
(2023). Sleep spindles detector (2024.12.13). GitHub, Zenodo. https://doi.org/10.5281/zenodo.10066031
Contribution 
These pipelines were created and is maintained by SJG.
Contributions are more than welcome so feel free to submit a pull request!
To report a bug, please open a new issue.
Note that this program is provided with NO WARRANTY OF ANY KIND under Apache 2.0 license.
Installation of Python package
To install the toolbox, simply use:
- Using conda
python
conda install -c cf-staging ssp_detector
- Using pip
python
pip install ssp_detector
Everything worked if the following command do not return any error:
```python import mne from sspdetector import spindlesabs from sspdetector import spindlesrel from tkinter import filedialog as fd
Load an EDF file using MNE
edf=fd.askopenfilename(title='SELECT EDF FILE',filetypes=(("EDF files",".edf"),("all files",".*"))) raw=mne.io.readrawedf(edf,preload=True) sfreq=raw.info['sfreq']
Return sleep spindles count
spindlesabs(raw,sf=sfreq,thresh={'abspow':1.25}) spindlesrel(raw,sf=sfreq,thresh={'relpow':0.2}) ```
Absolute Sigma power formula:
math
P_{abs\sigma}(dB)=log10(\tfrac{\int_{11}^{16}\left|x(t)\right|^{2}dt}{\int_{0.1}^{45}\left|x(t)\right|^{2}dt})$
log10(\tfrac{\int_{11}^{16}\left|x(t)\right|^{2}dt}{\int_{0.5}^{4}\left|x(t)\right|^{2}dt})
Relative Sigma power formula:
math
P_{rel\sigma}(dB)=log10(\tfrac{\int_{11}^{16}\left|x(t)\right|^{2}dt}{\int_{0.1}^{45}\left|x(t)\right|^{2}dt})$
log10(\tfrac{\int_{11}^{16}\left|x(t)\right|^{2}dt}{\int_{0.1}^{45}\left|x(t)\right|^{2}dt})
Owner
- Name: S.J. Guillot
- Login: sjg2203
- Kind: user
- Company: Columbia University Irving Medical Center
- Website: sjg2203.github.io
- Twitter: sjg_neuro
- Repositories: 12
- Profile: https://github.com/sjg2203
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: Sleep Spindles Detector
message: >-
If you use this toolbox, please cite as follows: Guillot,
S.J. (2023). Sleep Spindles Detector (2024.12.13). GitHub,
Zenodo. https://doi.org/10.5281/zenodo.10066031
type: software
authors:
- given-names: Simon J
family-names: Guillot
email: simon.guillot@inserm.fr
affiliation: University of Oxford
orcid: 'https://orcid.org/0000-0002-1623-7091'
identifiers:
- type: doi
value: 10.5281/zenodo.10651391
description: Zenodo
repository-code: 'https://github.com/sjg2203/SSp_Detector'
abstract: >-
SSp Detector (Sleep Spindles Detector): Sleep Spindles
Detector toolbox analyses raw EEG signals to then
extrapolate the number of sleep spindles using either the
absolute or relative Sigma power (11-16Hz).
keywords:
- Sleep
- Sleep spindles
- EEG
- Python
license: Apache-2.0
commit: d419e4a
version: 2024.12.13
date-released: '2024-12-13'
GitHub Events
Total
- Release event: 3
- Delete event: 1
- Push event: 14
- Create event: 3
Last Year
- Release event: 3
- Delete event: 1
- Push event: 14
- Create event: 3