neurodsp.sim.signals.MultiSimulations

class neurodsp.sim.signals.MultiSimulations(signals=None, params=None, function=None, update=None, component=None)

Data object for multiple sets of simulated signals.

Parameters:

signalslist of 2d array

Sets of simulated signals, with each array organized as [n_sims, sig_length].

paramslist of dict

The simulation parameters that were used to create the simulations.

functionstr or list of str

The simulation function(s) that were used to create the simulations.

updatestr

The name of the parameter that is updated across sets of simulations.

componentstr

Which component the updated parameter is part of. Only used if the parameter definition is for a multi-component simulation.

Notes

This object stores a set of simulations with multiple instances per parameter definition.

__init__(signals=None, params=None, function=None, update=None, component=None)

Initialize MultiSimulations object.

Methods

__init__([signals, params, function, ...])	Initialize MultiSimulations object.
add_signals(signals[, params, function])	Add a set of signals to the current object.

Attributes

fs	Alias fs as a property.
function	Alias func as property.
has_signals	Indicator for if the object has signals.
n_seconds	Alias n_seconds as a property.
params	Alias in the set of parameters across all sets of simulations.
values	Alias in the parameter definition of the parameter that varies across the sets.

add_signals(signals, params=None, function=None)

Add a set of signals to the current object.

Parameters:

signals2d array or list of 2d array or Simulations

A set of simulated signals, organized as [n_sims, sig_length].

paramsdict or list of dict, optional

The simulation parameters that were used to create the set of simulations.

functionstr, optional

The simulation function that was used to create the set of simulations.

property fs

Alias fs as a property.

property function

Alias func as property.

property has_signals

Indicator for if the object has signals.

property n_seconds

Alias n_seconds as a property.

property params

Alias in the set of parameters across all sets of simulations.

property values

Alias in the parameter definition of the parameter that varies across the sets.

Examples using neurodsp.sim.signals.MultiSimulations

Simulating Multiple Signals

Simulating Multiple Signals