Modules tutorials

Spike interface is split in several modules. Here are tutorials for each one.

Core tutorials

The spikeinterface.core module

  • RecordingExtractors

  • SortingExtractors

  • Handling probe information

Recording objects

Recording objects

Recording objects
Sorting objects

Sorting objects

Sorting objects
Handling probe information

Handling probe information

Handling probe information
Waveform Extractor

Waveform Extractor

Waveform Extractor
Append and/or concatenate segments

Append and/or concatenate segments

Append and/or concatenate segments
Handle time information

Handle time information

Handle time information

Extractors tutorials

The spikeinterface.extractors module is designed to load and save recorded and sorted data and to handle probe information.

  • RecordingExtractors

  • SortingExtractors

  • Handling probe information

Read various format into SpikeInterface

Read various format into SpikeInterface

Read various format into SpikeInterface
Working with unscaled traces

Working with unscaled traces

Working with unscaled traces

Preprocessing tutorial

The spikeinterface.preprocessing module allows users to preprocess recordings before spike sorting.

Preprocessing Tutorial

Preprocessing Tutorial

Preprocessing Tutorial

Sorters tutorials

The spikeinterface.sorters module wraps several spike sorting algorithms with the same simple Python API.

  • run sorters with different parameters

  • spike sort by property

  • use the sorter launcher

Run spike sorting algorithms

Run spike sorting algorithms

Run spike sorting algorithms
Use the spike sorting launcher

Use the spike sorting launcher

Use the spike sorting launcher
Run spike sorting by property

Run spike sorting by property

Run spike sorting by property
Run spike sorting on concatenated recordings

Run spike sorting on concatenated recordings

Run spike sorting on concatenated recordings

Postprocessing tutorial

The spikeinterface.postptocessing module contains a set of functions to combine recordings and sorting outputs for various additional computations.

Postprocessing Tutorial

Postprocessing Tutorial

Postprocessing Tutorial

Quality metrics tutorial

The spikeinterface.qualitymetrics module allows users to compute various quality metrics to assess the goodness of a spike sorting output.

Quality Metrics Tutorial

Quality Metrics Tutorial

Quality Metrics Tutorial
Curation Tutorial

Curation Tutorial

Curation Tutorial

Comparison tutorials

The spikeinterface.comparison module allows to compare spike sorting output with and without ground-truth information.

Compare two sorters

Compare two sorters

Compare two sorters
Compare multiple sorters and consensus based method

Compare multiple sorters and consensus based method

Compare multiple sorters and consensus based method
Compare spike sorting output with ground-truth recordings

Compare spike sorting output with ground-truth recordings

Compare spike sorting output with ground-truth recordings
Ground truth study tutorial

Ground truth study tutorial

Ground truth study tutorial
Explore sorters weaknesses with ground-truth comparison

Explore sorters weaknesses with ground-truth comparison

Explore sorters weaknesses with ground-truth comparison

Widgets tutorials

The widgets module contains several plotting routines (widgets) for visualizing recordings and sorting data, probe layout, and many more!

RecordingExtractor Widgets Gallery

RecordingExtractor Widgets Gallery

RecordingExtractor Widgets Gallery
SortingExtractor Widgets Gallery

SortingExtractor Widgets Gallery

SortingExtractor Widgets Gallery
Waveforms Widgets Gallery

Waveforms Widgets Gallery

Waveforms Widgets Gallery
Peaks Widgets Gallery

Peaks Widgets Gallery

Peaks Widgets Gallery

Gallery generated by Sphinx-Gallery