ivneuro.generate_signal

Function to generate a signal, used for examples of other functions of the package.

Functions

generate_signal(duration, burst_timestamps, ...[, ...])

Generate a signal with pink noise and increases in power (bursts) at a specified frequency.

Module Contents

ivneuro.generate_signal.generate_signal(duration, burst_timestamps, burst_frequency, burst_duration=2, burst_amplitude=0.1, sampling_frequency=1000, seed=40)

Generate a signal with pink noise and increases in power (bursts) at a specified frequency.

Parameters:

  • duration (int or float) – Duration of the signal in seconds.

  • burst_timestamps (list of floats) – Timestamps at wich the increases in power must occur.

  • burst_frequency (int or float) – Frequency at wich the signal displays increases in power.

  • burst_duration (int or float, optional) – Duration (in seconds) of high power burst. The default is 2.

  • burst_amplitude (int or float, optional) – Amplitud of the signal used to create the increases in power. The default is 0.1.

  • sampling_frequency (int, optional) – Sampling frequency. The default is 1000.

  • int (seed =)

  • optional

  • 40. (Value for np.random.seed to generate pink noise. The default is)

Returns:

signal – Timestamps as index and signal values as values.

Return type:

pandas DataFrame