brainspy.processors.simulation.noise package#

Module contents#

Package containing classes for generating noise.

Submodules#

brainspy.processors.simulation.noise.noise module#

File containing classes for generating noise.

class brainspy.processors.simulation.noise.noise.GaussianNoise(variance: float)[source]#

Bases: object

Class for generating and applying Gaussian noise.

brainspy.processors.simulation.noise.noise.get_noise(configs: dict, **kwargs)[source]#

Get given noise type.

Example

>>> get_noise(noise_type="gaussian", variance=1)
GaussianNoise
Parameters:

  • configs (dict) –

    A dictionary containing the configurations to declare different types of noise. The dictionary should at least contain the following keys:

    1. type : str Type of noise to be applied. The only currently implemented noise type is ‘gaussian’.

    2. variance: The variance of the noise. It is typically defined by the root mean squared deviation error obtained during the training of a surrogate model.

  • **kwargs – Arguments for the noise.

Returns:

A noise generating object. Will be None if input is None or not recognized.

Return type:

noise

Raises:

UserWarning – If the string given does not correspond to an implemented noise type.