neurodsp.sim.update.SigIter¶
- class neurodsp.sim.update.SigIter(function, params, n_sims=None)[source]¶
Object for iterating across sampled simulations.
- Parameters:
- functionstr or callable
Function to create simulations. If string, should be the name of the desired simulation function.
- paramsdict
Simulation parameters.
- n_simsint, optional
Number of simulations to create. If None, creates an infinite generator.
- Attributes:
- indexint
Index of current location through the iteration.
- yieldergenerator
Generator for sampling the sig iterations.
Methods
__init__(function, params[, n_sims])Initialize signal iteration object.
Attributes
Alias in base parameters as property attribute.
- property base¶
Alias in base parameters as property attribute.
