WhiteNoiseGenerator

WhiteNoiseGenerator#

class do_dpc.control_utils.noise_generators.WhiteNoiseGenerator(mean=None, std=None, seed=None)[source]#

Bases: object

This class generates Gaussian white noise with a specified mean and standard deviation. The standard deviation can vary for each state dimension, providing flexibility in noise generation.

mean#

The mean of the Gaussian noise.

Type:

float

std#

Standard deviations for each state dimension.

Type:

np.ndarray

rng#

Random number generator used for generating noise.

Type:

np.random.Generator

Parameters:

  • mean (Optional[np.ndarray]) – Mean of the Gaussian noise.

  • std (Optional[np.ndarray], optional) – Standard deviation for each state dimension. If not provided, defaults to an array of 1.0.

  • seed (Optional[int], optional) – Random seed for reproducibility.

Raises:

ValueError – If the standard deviations are not provided in an appropriate format (must be a 1D array or scalar).

Methods#

generate#

do_dpc.control_utils.noise_generators.WhiteNoiseGenerator.generate(self)#

Generates white noise of the given size.

Returns:

Generated white noise samples.

Return type:

np.ndarray

Contents