Skip to main content

A collection of tools for sleep research

Project description

sleep-utils

A python toolbox for sleep researchers. Plot hypnograms, spectrograms, confusion matrices, PSG summaries

sample_hypnogram.png spectrogram_multitaper.png
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))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sleep_utils-1.22.tar.gz (38.0 kB view details)

Uploaded Source

Built Distribution

sleep_utils-1.22-py3-none-any.whl (39.2 kB view details)

Uploaded Python 3

File details

Details for the file sleep_utils-1.22.tar.gz.

File metadata

  • Download URL: sleep_utils-1.22.tar.gz
  • Upload date:
  • Size: 38.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for sleep_utils-1.22.tar.gz
Algorithm Hash digest
SHA256 4556c4eedc01aa0b898ab709ad443095e08f7dab0807d5e2a4a73f1929fd0fd4
MD5 7ff9c83a7bd689840d15107bcf3a5510
BLAKE2b-256 5f68bec66d624f7cceb8920e454336c2291c2545bda5345101ac94fb2c4fb173

See more details on using hashes here.

File details

Details for the file sleep_utils-1.22-py3-none-any.whl.

File metadata

  • Download URL: sleep_utils-1.22-py3-none-any.whl
  • Upload date:
  • Size: 39.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for sleep_utils-1.22-py3-none-any.whl
Algorithm Hash digest
SHA256 ca8d0676532a9009891d33f0daee1a348030fd0297040cf8c27563d61e2824a4
MD5 7cbec68ccade8ea86ec7071b971a48aa
BLAKE2b-256 866f89b0b85b97eae31f4e7e8aa4381b2d2d97d47ffdb44be719d7ac6647760d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page