neurodsp.sim.multi.sim_multiple

neurodsp.sim.multi.sim_multiple(function, params, n_sims)[source]

Simulate multiple samples of a specified simulation.

Parameters:
functionstr or callable

Function to create the simulated time series. If string, should be the name of the desired simulation function.

paramsdict

The parameters for the simulated signal, passed into function.

n_simsint

Number of simulations to create.

Returns:
simsSimulations

Simulations object with simulated time series and metadata. Simulated signals are in the ‘signals’ attribute with shape [n_sims, sig_length].

Examples

Simulate multiple samples of a powerlaw signal:

>>> from neurodsp.sim.aperiodic import sim_powerlaw
>>> params = {'n_seconds' : 2, 'fs' : 250, 'exponent' : -1}
>>> sims = sim_multiple(sim_powerlaw, params, n_sims=3)