ezmsg.simbiophys.noise#

Noise signal generators.

Classes

class PinkNoise(*args, settings=None, **kwargs)[source]#

Bases: BaseClockDrivenUnit[PinkNoiseSettings, PinkNoiseProducer]

Generates pink (1/f) noise synchronized to clock ticks.

Receives timing from INPUT_CLOCK (LinearAxis from Clock) and outputs pink noise AxisArray on OUTPUT_SIGNAL.

Parameters:: settings (Settings | None)

SETTINGS#: alias of PinkNoiseSettings

class PinkNoiseProducer(*args, **kwargs)[source]#

Bases: CompositeProcessor[PinkNoiseSettings, LinearAxis, AxisArray]

Generates pink (1/f) noise synchronized to clock ticks.

Pink noise is generated by filtering white noise with a first-order lowpass Butterworth filter.

class PinkNoiseSettings(fs, n_time=None, n_ch=1, loc=0.0, scale=1.0, cutoff=300.0)[source]#

Bases: WhiteNoiseSettings

Settings for pink noise generator.

Parameters:

fs (float)
n_time (int | None)
n_ch (int)
loc (float)
scale (float)
cutoff (float)

cutoff: float = 300.0#: Lowpass cutoff frequency (Hz) for the first-order Butterworth filter that creates the 1/f characteristic.

__init__(fs, n_time=None, n_ch=1, loc=0.0, scale=1.0, cutoff=300.0)#

Parameters:

fs (float)
n_time (int | None)
n_ch (int)
loc (float)
scale (float)
cutoff (float)

Return type:

None

fs: float#: Output sampling rate in Hz.

class WhiteNoise(*args, settings=None, **kwargs)[source]#

Bases: BaseClockDrivenUnit[WhiteNoiseSettings, WhiteNoiseProducer]

Generates white noise synchronized to clock ticks.

Receives timing from INPUT_CLOCK (LinearAxis from Clock) and outputs white noise AxisArray on OUTPUT_SIGNAL.

Parameters:: settings (Settings | None)

SETTINGS#: alias of WhiteNoiseSettings

class WhiteNoiseProducer(*args, **kwargs)[source]#

Bases: BaseClockDrivenProducer[WhiteNoiseSettings, WhiteNoiseState]

Generates white noise synchronized to clock ticks.

Each clock tick produces a block of Gaussian white noise based on the sample rate (fs) and chunk size (n_time) settings.

class WhiteNoiseSettings(fs, n_time=None, n_ch=1, loc=0.0, scale=1.0)[source]#

Bases: ClockDrivenSettings

Settings for white noise generators.

Parameters:

fs (float)
n_time (int | None)
n_ch (int)
loc (float)
scale (float)

n_ch: int = 1#: Number of channels to output.

loc: float = 0.0#: DC offset (mean of the distribution).

scale: float = 1.0#: Scale (standard deviation of the distribution).

__init__(fs, n_time=None, n_ch=1, loc=0.0, scale=1.0)#

Parameters:

fs (float)
n_time (int | None)
n_ch (int)
loc (float)
scale (float)

Return type:

None

fs: float#: Output sampling rate in Hz.

class WhiteNoiseState[source]#

Bases: ClockDrivenState

State for WhiteNoiseProducer.

template: AxisArray | None = None#

class WhiteNoiseSettings(fs, n_time=None, n_ch=1, loc=0.0, scale=1.0)[source]#

Bases: ClockDrivenSettings

Settings for white noise generators.

Parameters:

fs (float)
n_time (int | None)
n_ch (int)
loc (float)
scale (float)

n_ch: int = 1#: Number of channels to output.

loc: float = 0.0#: DC offset (mean of the distribution).

scale: float = 1.0#: Scale (standard deviation of the distribution).

__init__(fs, n_time=None, n_ch=1, loc=0.0, scale=1.0)#

Parameters:

fs (float)
n_time (int | None)
n_ch (int)
loc (float)
scale (float)

Return type:

None

fs: float#: Output sampling rate in Hz.

class WhiteNoiseState[source]#

Bases: ClockDrivenState

State for WhiteNoiseProducer.

template: AxisArray | None = None#

class WhiteNoiseProducer(*args, **kwargs)[source]#

Bases: BaseClockDrivenProducer[WhiteNoiseSettings, WhiteNoiseState]

Generates white noise synchronized to clock ticks.

Each clock tick produces a block of Gaussian white noise based on the sample rate (fs) and chunk size (n_time) settings.

class WhiteNoise(*args, settings=None, **kwargs)[source]#

Bases: BaseClockDrivenUnit[WhiteNoiseSettings, WhiteNoiseProducer]

Generates white noise synchronized to clock ticks.

Receives timing from INPUT_CLOCK (LinearAxis from Clock) and outputs white noise AxisArray on OUTPUT_SIGNAL.

Parameters:: settings (Settings | None)

SETTINGS#: alias of WhiteNoiseSettings

class PinkNoiseSettings(fs, n_time=None, n_ch=1, loc=0.0, scale=1.0, cutoff=300.0)[source]#

Bases: WhiteNoiseSettings

Settings for pink noise generator.

Parameters:

fs (float)
n_time (int | None)
n_ch (int)
loc (float)
scale (float)
cutoff (float)

cutoff: float = 300.0#: Lowpass cutoff frequency (Hz) for the first-order Butterworth filter that creates the 1/f characteristic.

__init__(fs, n_time=None, n_ch=1, loc=0.0, scale=1.0, cutoff=300.0)#

Parameters:

fs (float)
n_time (int | None)
n_ch (int)
loc (float)
scale (float)
cutoff (float)

Return type:

None

fs: float#: Output sampling rate in Hz.

class PinkNoiseProducer(*args, **kwargs)[source]#

Bases: CompositeProcessor[PinkNoiseSettings, LinearAxis, AxisArray]

Generates pink (1/f) noise synchronized to clock ticks.

Pink noise is generated by filtering white noise with a first-order lowpass Butterworth filter.

class PinkNoise(*args, settings=None, **kwargs)[source]#

Bases: BaseClockDrivenUnit[PinkNoiseSettings, PinkNoiseProducer]

Generates pink (1/f) noise synchronized to clock ticks.

Receives timing from INPUT_CLOCK (LinearAxis from Clock) and outputs pink noise AxisArray on OUTPUT_SIGNAL.

Parameters:: settings (Settings | None)

SETTINGS#: alias of PinkNoiseSettings

ezmsg.simbiophys.noise#

This Page