Curation Tutorial

After spike sorting and computing quality metrics, you can automatically curate the spike sorting output using the quality metrics that you have calculated.

Import the modules and/or functions necessary from spikeinterface

import spikeinterface.core as si

from spikeinterface.qualitymetrics import compute_quality_metrics

Let’s generate a simulated dataset, and imagine that the ground-truth sorting is in fact the output of a sorter.

recording, sorting = si.generate_ground_truth_recording()
print(recording)
print(sorting)

GroundTruthRecording (InjectTemplatesRecording): 4 channels - 25.0kHz - 1 segments
                      250,000 samples - 10.00s - float32 dtype - 3.81 MiB
GroundTruthSorting (NumpySorting): 10 units - 1 segments - 25.0kHz

Create SortingAnalyzer

For this example, we will need a SortingAnalyzer and some extensions to be computed first

analyzer = si.create_sorting_analyzer(sorting=sorting, recording=recording, format="memory")
analyzer.compute(["random_spikes", "waveforms", "templates", "noise_levels"])

analyzer.compute("principal_components", n_components=3, mode="by_channel_local")
print(analyzer)

estimate_sparsity (no parallelization):   0%|          | 0/10 [00:00<?, ?it/s]
estimate_sparsity (no parallelization): 100%|██████████| 10/10 [00:00<00:00, 362.68it/s]

compute_waveforms (no parallelization):   0%|          | 0/10 [00:00<?, ?it/s]
compute_waveforms (no parallelization): 100%|██████████| 10/10 [00:00<00:00, 274.39it/s]

noise_level (no parallelization):   0%|          | 0/20 [00:00<?, ?it/s]
noise_level (no parallelization): 100%|██████████| 20/20 [00:00<00:00, 256.45it/s]

Fitting PCA:   0%|          | 0/10 [00:00<?, ?it/s]
Fitting PCA: 100%|██████████| 10/10 [00:00<00:00, 135.76it/s]

Projecting waveforms:   0%|          | 0/10 [00:00<?, ?it/s]
Projecting waveforms: 100%|██████████| 10/10 [00:00<00:00, 1294.46it/s]
SortingAnalyzer: 4 channels - 10 units - 1 segments - memory - sparse - has recording
Loaded 5 extensions: random_spikes, waveforms, templates, noise_levels, principal_components

Then we compute some quality metrics:

metrics = compute_quality_metrics(analyzer, metric_names=["snr", "isi_violation", "nearest_neighbor"])
print(metrics)

calculate pc_metrics:   0%|          | 0/10 [00:00<?, ?it/s]
calculate pc_metrics:  30%|███       | 3/10 [00:00<00:00, 29.58it/s]
calculate pc_metrics:  80%|████████  | 8/10 [00:00<00:00, 36.71it/s]
calculate pc_metrics: 100%|██████████| 10/10 [00:00<00:00, 36.49it/s]
         snr  isi_violations_ratio  ...  nn_hit_rate  nn_miss_rate
0   0.556296                   0.0  ...     0.435583      0.060517
1  35.588983                   0.0  ...     0.983553      0.003843
2  11.238775                   0.0  ...     0.802920      0.013758
3  11.253016                   0.0  ...     0.843137      0.021245
4   7.810827                   0.0  ...     0.874233      0.020849
5   8.138023                   0.0  ...     0.787162      0.025912
6  20.778823                   0.0  ...     0.918239      0.006623
7  15.686725                   0.0  ...     0.862595      0.009193
8  14.360175                   0.0  ...     0.899351      0.011547
9   0.657849                   0.0  ...     0.473101      0.066360

[10 rows x 5 columns]

We can now threshold each quality metric and select units based on some rules.

The easiest and most intuitive way is to use boolean masking with a dataframe.

Then create a list of unit ids that we want to keep

keep_mask = (metrics["snr"] > 7.5) & (metrics["isi_violations_ratio"] < 0.2) & (metrics["nn_hit_rate"] > 0.90)
print(keep_mask)

keep_unit_ids = keep_mask[keep_mask].index.values
keep_unit_ids = [unit_id for unit_id in keep_unit_ids]
print(keep_unit_ids)

0    False
1     True
2    False
3    False
4    False
5    False
6     True
7    False
8    False
9    False
dtype: bool
['1', '6']

And now let’s create a sorting that contains only curated units and save it.

curated_sorting = sorting.select_units(keep_unit_ids)
print(curated_sorting)


curated_sorting.save(folder="curated_sorting")

GroundTruthSorting (UnitsSelectionSorting): 2 units - 1 segments - 25.0kHz

NumpyFolder (NumpyFolderSorting): 2 units - 1 segments - 25.0kHz

Unit IDs

['1' '6']

Annotations

• name : GroundTruthSorting

Properties

gt_unit_locations
[[21.019224 14.061782 5.1045833] [-4.432927 29.777784 11.257349 ]]

We can also save the analyzer with only theses units

clean_analyzer = analyzer.select_units(unit_ids=keep_unit_ids, format="zarr", folder="clean_analyzer")

print(clean_analyzer)

SortingAnalyzer: 4 channels - 2 units - 1 segments - zarr - sparse - has recording
Loaded 6 extensions: random_spikes, waveforms, templates, noise_levels, principal_components, quality_metrics