module documentation

Undocumented

Class WhiteNoiseFunction Undocumented
Function broadband_noise No summary
Function broadband_noise_n Undocumented
Function normal_distributed_white_noise_generator Undocumented
Function uniform_white_noise_generator Undocumented
Function white_noise Generate white noise of the length of the time vector
Function white_noise_n Undocumented
def broadband_noise(t, amp=0.1, freq_range=None, dtype=float): (source)
Parameters
t:np.ndarraytime vector
amp:floatamplitude
freq_range:Annotated[List[float], ExactLen(2)]desired frequency range
dtype:typedesired datatype
Returns
np.ndarraynoise signal
def broadband_noise_n(fs=1000000.0, amp=0.1, duration=1.0, freq_range=None, dtype=float): (source)

Undocumented

Parameters
fs:Union[float, int]Undocumented
amp:floatUndocumented
duration:floatUndocumented
freq_range:List[float]Undocumented
dtype:typeUndocumented
Returns
np.ndarrayUndocumented
def normal_distributed_white_noise_generator(n): (source)

Undocumented

Parameters
n:intUndocumented
Returns
np.ndarrayUndocumented
def uniform_white_noise_generator(n): (source)

Undocumented

Parameters
n:intUndocumented
Returns
np.ndarrayUndocumented
def white_noise(t, amp=0.1, generator=uniform_white_noise_generator, dtype=float): (source)

Generate white noise of the length of the time vector

Example:

    >>> from data_creation.time.time import generate_time_vector
    >>> t = generate_time_vector(0.0, 1.0, 1000)
    >>> x = white_noise(t, 0.5)
Parameters
t:np.ndarraytime vector
amp:floatamplitude
generator:WhiteNoiseFunctiongenerator function (most fulfill the WhiteNoiseFunction.protocol)
dtype:typedatatype
Returns
np.ndarraynoise signal
def white_noise_n(n, generator=uniform_white_noise_generator, dtype=float): (source)

Undocumented

Parameters
n:intUndocumented
generator:WhiteNoiseFunctionUndocumented
dtype:typeUndocumented
Returns
np.ndarrayUndocumented