neurodsp.sim.sim_damped_oscillation

neurodsp.sim.sim_damped_oscillation(n_seconds, fs, freq, gamma, growth=None)[source]

Simulate a damped relaxation oscillation.

Parameters
n_secondsfloat

Simulation time, in seconds.

fsfloat

Signal sampling rate, in Hz.

freqfloat

Oscillation frequency, in Hz.

gammafloat

Parametric dampening coefficient.

growthfloat, optional, default: None

Logistic growth rate to smooth the heaviside step function. If None, a non-smoothed heaviside is used.

Returns
sig1d array

Simulated damped relaxation oscillation.

Notes

  • This implementation of a damped oscillation is implemented as Equation 3 of [1].

References

1

Evertz, R., Hicks, D. G., & Liley, D. T. J. (2021). Alpha blocking and 1/fβ spectral scaling in resting EEG can be accounted for by a sum of damped alpha band oscillatory processes. bioRxiv. DOI: https://doi.org/10.1101/2021.08.20.457060

Examples

Simulate a damped alpha oscillation:

>>> sig = sim_damped_oscillation(1, 1000, 10, .1)

Examples using neurodsp.sim.sim_damped_oscillation

Simulating Periodic Signals

Simulating Periodic Signals