bmtk.simulator.utils.tools package

Submodules

bmtk.simulator.utils.tools.process_spikes module

bmtk.simulator.utils.tools.process_spikes.read_spk_h5(f_name)[source]
Parameters
f_name: string

Full path to a file containing cell IDs and spike times.

Returns
A dataframe containing two columns: spike times and cell IDs.
Usage:
x = read_spk_h5(‘output/spk.h5’)
bmtk.simulator.utils.tools.process_spikes.read_spk_txt(f_name)[source]
Parameters
f_name: string

Full path to a file containing cell IDs and spike times.

Returns
A dataframe containing two columns: spike times and cell IDs.
Usage:
x = read_spk_txt(‘output/spk.dat’)
bmtk.simulator.utils.tools.process_spikes.spikes_to_mean_f_rate(cells_f, spk_f, t_window, **kwargs)[source]
Parameters
cells_f: string

Full path to a file containing information about all cells (in particular, all cell IDs, and not just those that fired spikes in a simulation).

spk_f: string

Full path to a file containing cell IDs and spike times.

t_window: a tuple of two floats

Start and stop time for the window within which the firing rate is computed.

**kwargs
spk_f_type: string with accepted values ‘txt’ or ‘h5’

Type of the file from which spike times should be extracted.

Returns
A dataframe containing a column of cell IDs and a column of corresponding
average firing rates.
Usage:
x = spikes_to_mean_f_rate(‘../network_model/cells.csv’, ‘output/spk.dat’, (500.0, 3000.0))

bmtk.simulator.utils.tools.spatial module

bmtk.simulator.utils.tools.spatial.example()[source]

Module contents