osl_dynamics.simulation.HMM_OscillatoryBursts#

class osl_dynamics.simulation.HMM_OscillatoryBursts(n_samples, n_subjects=1, n_groups=1, true_freqs=None, group_freq_shift=0.5, channel_activity=None, n_modes=4, n_channels_per_mode=8, sampling_frequency=100, snr=4, stay_prob=0.98)#

Simulate an HMM with oscillatory burst observation model.

Uses an HMM to generate state time courses, then fills active periods with sinusoidal oscillations at specified frequencies. Each mode has a set of active channels and a characteristic frequency. An extra “background” state (silence) is included automatically.

Multiple subjects can be simulated with optional group-level frequency shifts.

Parameters:
n_samplesint

Number of time points per subject.

n_subjectsint, optional

Number of subjects.

n_groupsint, optional

Number of subject groups. n_subjects must be divisible by n_groups.

true_freqsnp.ndarray, optional

Frequencies for each mode in Hz. Shape: (n_modes,). If not provided, n_modes frequencies are linearly spaced between 8 and 25 Hz.

group_freq_shiftfloat, optional

Frequency shift between groups in Hz.

channel_activitynp.ndarray, optional

Binary matrix indicating active channels per mode. Shape: (n_modes, n_channels). If not provided, an identity-like matrix is created with n_channels_per_mode channels per mode.

n_modesint, optional

Number of frequency modes. Ignored if channel_activity is given.

n_channels_per_modeint, optional

Channels per mode when auto-generating channel_activity.

sampling_frequencyfloat, optional

Sampling frequency in Hz.

snrfloat, optional

Signal-to-noise ratio.

stay_probfloat, optional

HMM state stay probability.

n_samples#
n_subjects = 1#
n_groups = 1#
n_subjects_per_group = 1#
sampling_frequency = 100#
snr = 4#
stay_prob = 0.98#
true_freqs#
hmm#
property time_series#

np.ndarray: Simulated data. Shape: (n_subjects, n_samples, n_channels).

property state_time_course#

np.ndarray: State time courses. Shape: (n_subjects, n_samples, n_modes + 1).