# sleep-utils
A python toolbox for sleep researchers. Plot hypnograms, spectrograms, confusion matrices, PSG summaries
<img src="./assets/d1f7592a94f0f39c4d672c5913e161ec16193458.png" title="" alt="sample_hypnogram.png" width="394">
<img src="./assets/c49446ae6d84dee6e13ae14034dd12eb6bbdb48d.png" title="" alt="spectrogram_multitaper.png" width="395">
<img src="md_assets/2022-07-25-13-06-18-image.png" title="" alt="" width="409">
```
Hypnogram summary
{'TRT': 460.5,
'TST': 444.5,
'WASO': 16.0,
'lat_REM': 65.0,
'lat_S1': 0.0,
'lat_S2': 2.0,
'lat_S3': 9.0,
'min_REM': 109.5,
'min_S1': 13.5,
'min_S2': 214.0,
'min_S3': 107.5,
'perc_REM': 0.24634420697412823,
'perc_S1': 0.030371203599550055,
'perc_S2': 0.4814398200224972,
'perc_S3': 0.24184476940382452,
'perc_W': 0.03474484256243214,
'recording_length': 547.0,
'sleep_offset_after_rec_start': 534.0,
'sleep_onset_after_rec_start': 73.5}
```
#### Install
```
pip install sleep-utils
```
or
```
pip install git+https://github.com/skjerns/sleep-utils
```
#### Functionality
`import sleep_utils`
- hypnograms
- load (`sleep_utils.read_hypno(file)`)
- save(`sleep_utils.write_hypno(hypno, file)`
- plot (`sleep_utils.plot_hypnogram(hypno)`)
- convert (read&save)
- print summary (TST, WASO, ...) (`sleep_utils.hypno_summary(hypno)`)
- spectrograms
- multitaper spectrogram (`sleep_utils.specgram_multitaper(data, sfreq)`)
- welch spectrogram(`sleep_utils.specgram_welch(data, sfreq)`)
- confusion matrix
- plot inter rater confusion matrix (`sleep_utils.plot_confusion_matrix(confmat)`)
- mne-edf
- save MNE to edf (`sleep_utils.write_mne_edf(raw, filename)`)
Raw data
{
"_id": null,
"home_page": "http://github.com/skjerns/sleep-utils",
"name": "sleep-utils",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "skjerns",
"author_email": "nomail@nomail.com",
"download_url": "https://files.pythonhosted.org/packages/f5/37/529a8d56cfce424a9fa0e3e9a0d9c625e072a60b672215e5221863a5db6b/sleep_utils-1.25.tar.gz",
"platform": null,
"description": "# sleep-utils\n\nA python toolbox for sleep researchers. Plot hypnograms, spectrograms, confusion matrices, PSG summaries\n\n<img src=\"./assets/d1f7592a94f0f39c4d672c5913e161ec16193458.png\" title=\"\" alt=\"sample_hypnogram.png\" width=\"394\">\n\n<img src=\"./assets/c49446ae6d84dee6e13ae14034dd12eb6bbdb48d.png\" title=\"\" alt=\"spectrogram_multitaper.png\" width=\"395\">\n\n<img src=\"md_assets/2022-07-25-13-06-18-image.png\" title=\"\" alt=\"\" width=\"409\">\n\n```\nHypnogram summary\n{'TRT': 460.5,\n 'TST': 444.5,\n 'WASO': 16.0,\n 'lat_REM': 65.0,\n 'lat_S1': 0.0,\n 'lat_S2': 2.0,\n 'lat_S3': 9.0,\n 'min_REM': 109.5,\n 'min_S1': 13.5,\n 'min_S2': 214.0,\n 'min_S3': 107.5,\n 'perc_REM': 0.24634420697412823,\n 'perc_S1': 0.030371203599550055,\n 'perc_S2': 0.4814398200224972,\n 'perc_S3': 0.24184476940382452,\n 'perc_W': 0.03474484256243214,\n 'recording_length': 547.0,\n 'sleep_offset_after_rec_start': 534.0,\n 'sleep_onset_after_rec_start': 73.5}\n```\n\n#### Install\n\n```\npip install sleep-utils\n```\n\nor\n\n```\npip install git+https://github.com/skjerns/sleep-utils\n```\n\n#### Functionality\n\n`import sleep_utils`\n\n- hypnograms\n \n - load (`sleep_utils.read_hypno(file)`)\n \n - save(`sleep_utils.write_hypno(hypno, file)`\n \n - plot (`sleep_utils.plot_hypnogram(hypno)`)\n \n - convert (read&save)\n \n - print summary (TST, WASO, ...) (`sleep_utils.hypno_summary(hypno)`)\n\n- spectrograms\n \n - multitaper spectrogram (`sleep_utils.specgram_multitaper(data, sfreq)`)\n \n - welch spectrogram(`sleep_utils.specgram_welch(data, sfreq)`)\n\n- confusion matrix\n \n - plot inter rater confusion matrix (`sleep_utils.plot_confusion_matrix(confmat)`)\n\n- mne-edf\n \n - save MNE to edf (`sleep_utils.write_mne_edf(raw, filename)`)\n\n",
"bugtrack_url": null,
"license": "GNU 2.0",
"summary": "A collection of tools for sleep research",
"version": "1.25",
"project_urls": {
"Homepage": "http://github.com/skjerns/sleep-utils"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1d068ad736f9056da0d3041395af6a990cbe32e9dfbe0878b60b6a96f27720e1",
"md5": "d34de3951cb8eff99e56ad303bcaaaf8",
"sha256": "f20c7ec16bd103509f64eead5afecdcfa5415db1b2854e5aba4f8cd90470a67b"
},
"downloads": -1,
"filename": "sleep_utils-1.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d34de3951cb8eff99e56ad303bcaaaf8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 40072,
"upload_time": "2025-10-09T13:33:22",
"upload_time_iso_8601": "2025-10-09T13:33:22.424283Z",
"url": "https://files.pythonhosted.org/packages/1d/06/8ad736f9056da0d3041395af6a990cbe32e9dfbe0878b60b6a96f27720e1/sleep_utils-1.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f537529a8d56cfce424a9fa0e3e9a0d9c625e072a60b672215e5221863a5db6b",
"md5": "45226db3079971f2505e691e81d28a6a",
"sha256": "165096cc74ebaf3ea7ab6c342c3c00fb1ce0dd7a8e86e234509f0e45ead28632"
},
"downloads": -1,
"filename": "sleep_utils-1.25.tar.gz",
"has_sig": false,
"md5_digest": "45226db3079971f2505e691e81d28a6a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38877,
"upload_time": "2025-10-09T13:33:23",
"upload_time_iso_8601": "2025-10-09T13:33:23.641867Z",
"url": "https://files.pythonhosted.org/packages/f5/37/529a8d56cfce424a9fa0e3e9a0d9c625e072a60b672215e5221863a5db6b/sleep_utils-1.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-09 13:33:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "skjerns",
"github_project": "sleep-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sleep-utils"
}
JSON
