yasa.plot_hypnogram

yasa.plot_hypnogram(hypno, sf_hypno=0.03333333333333333, lw=1.5, fill_color=None, ax=None)[source]

Plot a hypnogram.

New in version 0.6.0.

Parameters
hypnoarray_like

Sleep stage (hypnogram).

Note

The default hypnogram format in YASA is a 1D integer vector where:

  • -2 = Unscored

  • -1 = Artefact / Movement

  • 0 = Wake

  • 1 = N1 sleep

  • 2 = N2 sleep

  • 3 = N3 sleep

  • 4 = REM sleep

sf_hypnofloat

The current sampling frequency of the hypnogram, in Hz, e.g.

  • 1/30 = 1 value per each 30 seconds of EEG data,

  • 1 = 1 value per second of EEG data

lwfloat

Linewidth.

fill_colorstr

Color to fill space above hypnogram line, optional.

axmatplotlib.axes.Axes

Axis on which to draw the plot, optional.

Returns
axmatplotlib.axes.Axes

Matplotlib Axes

Examples

>>> import yasa
>>> import numpy as np
>>> import matplotlib.pyplot as plt
>>> hypno = np.loadtxt("https://github.com/raphaelvallat/yasa/raw/master/notebooks/data_full_6hrs_100Hz_hypno_30s.txt")
>>> fig, ax = plt.subplots(1, 1, figsize=(7, 3), constrained_layout=True)
>>> ax = yasa.plot_hypnogram(hypno, fill_color="gainsboro", ax=ax)
../_images/yasa-plot_hypnogram-1.png