frites.simulations.sim_local_ccd_ms

frites.simulations.sim_local_ccd_ms(n_subjects, random_state=None, **kwargs)

Multi-subjects simulations for computing local MI (CCD).

This function can be used for simulating local representations of mutual information between two continuous variables conditioned by a third discret one (CCD) across multiple subjects.

Parameters:

n_subjectsint

Number of subjects

random_stateint | None

Fix the random state of the machine (use it for reproducibility). If None, a random state is randomly assigned.

kwargsdict | {}

Additional arguments are send to the function sim_local_ccd_ss()

Returns:

xlist

List length n_subjects composed of data arrays each one with a shape of (n_epochs, n_channels, n_times)

ylist

List of length n_subjects composed of regressor arrays each one with a shape of (n_epochs)

znumpy:array_like

Condition array of shape (n_epochs,)

roilist

List of length n_subjects composed of roi arrays each one with a shape of (n_roi)

timesnumpy:array_like

Time vector