yasa.Hypnogram.simulate_similar#

Hypnogram.simulate_similar(**kwargs)[source]#

Simulate a new hypnogram based on properties of the current hypnogram.

See also

yasa.simulate_hypnogram

Parameters:

**kwargsdict: Optional keyword arguments passed to yasa.simulate_hypnogram.

Returns:

hypyasa.Hypnogram: A simulated hypnogram.

Examples

>>> import pandas as pd
>>> from yasa import Hypnogram
>>> hyp = Hypnogram(["W", "S", "W"], n_stages=2, freq="2min", scorer="Human").upsample(
...     "30s"
... )
>>> shyp = hyp.simulate_similar(scorer="Simulated", seed=6)
>>> df = pd.concat([hyp.hypno, shyp.hypno], axis=1)
>>> print(df)
       Human Simulated
Epoch
0       WAKE      WAKE
1       WAKE      WAKE
2       WAKE      WAKE
3       WAKE      WAKE
4      SLEEP     SLEEP
5      SLEEP     SLEEP
6      SLEEP     SLEEP
7      SLEEP     SLEEP
8       WAKE     SLEEP
9       WAKE     SLEEP
10      WAKE     SLEEP
11      WAKE      WAKE