spike_analysis ❭ core ❭ STAPlugin_annotate_bursts_in_st

STAPlugin_annotate_bursts_in_st¶

class spike_analysis.core.STAPlugin_annotate_bursts_in_st(name='bursts_st', source='st', event_maxtimes=None, event_names=None)¶

SpikeTimeAnalysis (STA) plugin to annotate bursts in a spike times dataframe.

See also

spike_analysis.core.SpikeTimesAnalysis reads in source.

Parameters:¶

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

• 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: annotates bursts in a spike times dataframe.