spike_analysiscoreSTAPlugin_bursts

STAPlugin_bursts

class spike_analysis.core.STAPlugin_bursts(name='bursts', source='spike_times', event_maxtimes=None, event_names=None)

SpikeTimeAnalysis (STA) plugin to detect high frequency events (doublet, triplet, …) that occur within a timewindow.

See also

spike_analysis.core.SpikeTimesAnalysis reads in source.

Parameters:
  • name (str, optional) – The name of the plugin. Defaults to ‘bursts’.

  • source (str, optional) – The DataBase key containing the spike times. Defaults to ‘spike_times’.

  • event_maxtimes (dict, optional) – Dictionary containing the maximum duration of each event type. Default: {0:0, 1:10, 2:30}

  • event_names (dict, optional) – Dictionary containing the names of the event types. Default: {0: "singlet", 1: "doublet", 2: "triplet"}

Attributes:

name

The name of the plugin.

Type:

str

source

The DataBase key containing the spike times. Defaults to ‘spike_times’.

Type:

str, optional

event_maxtimes

Dictionary containing the maximum duration of each event type.

Type:

dict

event_names

Dictionary containing the names of the event types.

Type:

dict

Methods:

setup(spike_times_analysis)

Sets up the analysis: Detects high frequency events (doublet, triplet, …) that occur within a timewindow.

event_analysis_bursts(row, event_maxtimes, event_names)

static Detects high frequency events (doublet, triplet, …) that occur within a timewindow.