osl_dynamics.analysis.post_hoc.mean_intervals#

osl_dynamics.analysis.post_hoc.mean_intervals(state_time_course, sampling_frequency=None)#

Calculate the mean interval of each state.

Parameters:
state_time_courselist or np.ndarray

State time course (strictly binary). Shape must be (n_sessions, n_samples, n_states) or (n_samples, n_states).

sampling_frequencyfloat, optional

Sampling frequency in Hz. If passed returns the intervals in seconds.

Returns:
mltnp.ndarray

Mean interval of each state. Shape is (n_sessions, n_states) or (n_states,).