Skip to main content

A collection of tools for sleep research

Project description


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}


pip install sleep-utils


pip install git+


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.15.tar.gz (22.4 kB view hashes)

Uploaded Source

Built Distribution

sleep_utils-1.15-py3-none-any.whl (22.9 kB view hashes)

Uploaded Python 3

Supported by

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