Correlograms & ISI#

Hide code cell content

import pynapple as nap
import numpy as np
import matplotlib.pyplot as plt
import seaborn as sns
custom_params = {"axes.spines.right": False, "axes.spines.top": False}
sns.set_theme(style="ticks", palette="colorblind", font_scale=1.5, rc=custom_params)

Let’s generate some data. Here we have two neurons recorded together. We can group them in a TsGroup.

ts1 = nap.Ts(t=np.sort(np.random.uniform(0, 1000, 2000)), time_units="s")
ts2 = nap.Ts(t=np.sort(np.random.uniform(0, 1000, 1000)), time_units="s")
epoch = nap.IntervalSet(start=0, end=1000, time_units="s")
ts_group = nap.TsGroup({0: ts1, 1: ts2}, time_support=epoch)
print(ts_group)
  Index    rate
-------  ------
      0       2
      1       1

Autocorrelograms#

We can compute their autocorrelograms meaning the number of spikes of a neuron observed in a time windows centered around its own spikes. For this we can use the function compute_autocorrelogram. We need to specify the binsize and windowsize to bin the spike train.

autocorrs = nap.compute_autocorrelogram(
    group=ts_group, binsize=100, windowsize=1000, time_units="ms", ep=epoch  # ms
)
print(autocorrs)
           0     1
-0.9  0.9750  0.81
-0.8  1.0075  1.00
-0.7  1.0025  1.05
-0.6  1.0725  1.09
-0.5  0.9625  1.09
-0.4  0.9850  1.02
-0.3  0.9550  1.20
-0.2  0.9775  0.88
-0.1  0.9800  0.91
 0.0  0.0000  0.00
 0.1  0.9800  0.91
 0.2  0.9775  0.88
 0.3  0.9550  1.20
 0.4  0.9850  1.02
 0.5  0.9625  1.09
 0.6  1.0725  1.09
 0.7  1.0025  1.05
 0.8  1.0075  1.00
 0.9  0.9750  0.81

The variable autocorrs is a pandas DataFrame with the center of the bins for the index and each column is an autocorrelogram of one unit in the TsGroup.

Cross-correlograms#

Cross-correlograms are computed between pairs of neurons.

crosscorrs = nap.compute_crosscorrelogram(
    group=ts_group, binsize=100, windowsize=1000, time_units="ms"  # ms
)
print(crosscorrs)
          0
          1
-0.9  0.995
-0.8  1.160
-0.7  0.965
-0.6  0.965
-0.5  1.010
-0.4  1.225
-0.3  1.010
-0.2  0.935
-0.1  1.070
 0.0  0.935
 0.1  0.835
 0.2  1.000
 0.3  1.010
 0.4  0.960
 0.5  1.045
 0.6  0.995
 0.7  0.980
 0.8  0.980
 0.9  0.955

Column name (0, 1) is read as cross-correlogram of neuron 0 and 1 with neuron 0 being the reference time.

Event-correlograms#

Event-correlograms count the number of event in the TsGroup based on an event timestamps object.

eventcorrs = nap.compute_eventcorrelogram(
    group=ts_group, event = nap.Ts(t=[0, 10, 20]), binsize=0.1, windowsize=1
    )
print(eventcorrs)
             0         1
-0.9  0.000000  2.777778
-0.8  4.878049  0.000000
-0.7  1.626016  0.000000
-0.6  1.626016  2.777778
-0.5  1.626016  0.000000
-0.4  0.000000  0.000000
-0.3  0.000000  0.000000
-0.2  0.000000  0.000000
-0.1  0.000000  0.000000
 0.0  0.000000  2.777778
 0.1  0.000000  0.000000
 0.2  0.000000  0.000000
 0.3  1.626016  0.000000
 0.4  0.000000  0.000000
 0.5  0.000000  0.000000
 0.6  1.626016  0.000000
 0.7  1.626016  0.000000
 0.8  0.000000  0.000000
 0.9  0.000000  0.000000

Interspike interval (ISI) distribution#

The interspike interval distribution shows how the time differences between subsequent spikes (events) are distributed. The input can be any object with timestamps. Passing epochs restricts the computation to the given epochs. The output will be a dataframe with the bin centres as index and containing the corresponding ISI counts per unit.

isi_distribution = nap.compute_isi_distribution(
    data=ts_group, bins=10, epochs=epoch
    )
print(isi_distribution)
             0    1
0.464515  1681  606
1.393350   273  248
2.322186    39   89
3.251021     5   24
4.179856     1   13
5.108692     0   14
6.037527     0    4
6.966362     0    0
7.895197     0    0
8.824033     0    1

Hide code cell source

for col in isi_distribution.columns:
    plt.bar(
        isi_distribution.index,
        isi_distribution[col].values,
        width=np.diff(isi_distribution.index).mean(),
        alpha=0.5,
        label=col,
        align='center',
        edgecolor='none'
    )
plt.xlabel("ISI (s)")
plt.ylabel("Count")
plt.legend(title="Unit")
plt.show()
../_images/e5d94a3cf71e08bd800eb1f5fd70294ffe573ca6e71553c7be5f4a04e5f0b188.png

The bins argument allows for choosing either the number of bins as an integer or the bin edges as an array directly:

isi_distribution = nap.compute_isi_distribution(
    data=ts_group, bins=np.linspace(0, 3, 10), epochs=epoch
    )
print(isi_distribution)
            0    1
0.166667  972  278
0.500000  499  215
0.833333  243  139
1.166667  134  111
1.500000   78   69
1.833333   42   55
2.166667   16   47
2.500000    6   26
2.833333    4   12

Hide code cell source

for col in isi_distribution.columns:
    plt.bar(
        isi_distribution.index,
        isi_distribution[col].values,
        width=np.diff(isi_distribution.index).mean(),
        alpha=0.5,
        label=col,
        align='center',
        edgecolor='none'
    )
plt.xlabel("log ISI (s)")
plt.ylabel("Count")
plt.legend(title="Unit")
plt.show()
../_images/38fd6aa164fcb11eaa0a9d677cb3af2430b79ec8928447cc03129e8dd5afc6c5.png

The log_scale argument allows for applying the log-transform to the ISIs:

isi_distribution = nap.compute_isi_distribution(
    data=ts_group, bins=10, log_scale=True, epochs=epoch
    )
print(isi_distribution)
             0    1
-8.662863    2    0
-7.516375    1    0
-6.369887   10    3
-5.223399   21    3
-4.076912   86   24
-2.930424  241   55
-1.783936  545  167
-0.637448  778  357
 0.509040  309  342
 1.655528    6   48

Hide code cell source

for col in isi_distribution.columns:
    plt.bar(
        isi_distribution.index,
        isi_distribution[col].values,
        width=np.diff(isi_distribution.index).mean(),
        alpha=0.5,
        label=col,
        align='center',
        edgecolor='none'
    )
plt.xlabel("log ISI (s)")
plt.ylabel("Count")
plt.legend(title="Unit")
plt.show()
../_images/7be95361264ed3e4ff1004f845f310c9b759953261d2a2a46f3547f0dc2ae992.png