Skip to content

Latest commit

 

History

History
377 lines (306 loc) · 11.2 KB

api.rst

File metadata and controls

377 lines (306 loc) · 11.2 KB

API

spikeinterface.core

spikeinterface.core

load_extractor

BaseRecording

BaseSorting

BaseSnippets

BaseEvent

WaveformExtractor

extract_waveforms

load_waveforms

compute_sparsity

ChannelSparsity

BinaryRecordingExtractor

ZarrRecordingExtractor

BinaryFolderRecording

NpzFolderSorting

NpyFolderSnippets

NumpyRecording

NumpySorting

NumpySnippets

AppendSegmentRecording

ConcatenateSegmentRecording

SelectSegmentRecording

AppendSegmentSorting

SplitSegmentSorting

SelectSegmentSorting

download_dataset

write_binary_recording

set_global_tmp_folder

set_global_dataset_folder

set_global_job_kwargs

get_random_data_chunks

get_channel_distances

get_closest_channels

get_noise_levels

get_chunk_with_margin

order_channels_by_depth

get_template_amplitudes

get_template_extremum_channel

get_template_extremum_channel_peak_shift

get_template_extremum_amplitude

append_recordings

concatenate_recordings

split_recording

select_segment_recording

append_sortings

split_sorting

select_segment_sorting

read_binary

read_zarr

Low-level

spikeinterface.core

BaseWaveformExtractorExtension

ChunkRecordingExecutor

spikeinterface.extractors

NEO-based

spikeinterface.extractors

read_alphaomega

read_alphaomega_event

read_axona

read_biocam

read_binary

read_blackrock

read_ced

read_intan

read_maxwell

read_mearec

read_mcsraw

read_neuralynx

read_neuralynx_sorting

read_neuroexplorer

read_neuroscope

read_nix

read_openephys

read_openephys_event

read_plexon

read_plexon_sorting

read_plexon2

read_plexon2_sorting

read_spike2

read_spikegadgets

read_spikeglx

read_tdt

read_zarr

Non-NEO-based

spikeinterface.extractors

read_alf_sorting

read_bids

read_cbin_ibl

read_combinato

read_ibl_streaming_recording

read_hdsort

read_herdingspikes

read_kilosort

read_klusta

read_mcsh5

read_mda_recording

read_mda_sorting

read_nwb

read_phy

read_shybrid_recording

read_shybrid_sorting

read_spykingcircus

toy_example

read_tridesclous

read_waveclus

read_yass

spikeinterface.preprocessing

spikeinterface.preprocessing

astype

average_across_direction

bandpass_filter

blank_staturation

center

clip

common_reference

correct_lsb

correct_motion

depth_order

detect_bad_channels

directional_derivative

filter

gaussian_filter

highpass_filter

highpass_spatial_filter

interpolate_bad_channels

normalize_by_quantile

notch_filter

phase_shift

rectify

remove_artifacts

resample

scale

silence_periods

unsigned_to_signed

whiten

zero_channel_pad

zscore

spikeinterface.postprocessing

spikeinterface.postprocessing

compute_noise_levels

compute_template_metrics

compute_principal_components

compute_spike_amplitudes

compute_unit_locations

compute_spike_locations

compute_template_similarity

compute_correlograms

compute_isi_histograms

get_template_metric_names

align_sorting

spikeinterface.qualitymetrics

spikeinterface.qualitymetrics

compute_quality_metrics

get_quality_metric_list

get_quality_pca_metric_list

get_default_qm_params

spikeinterface.sorters

spikeinterface.sorters

available_sorters

installed_sorters

get_default_sorter_params

get_sorter_params_description

print_sorter_versions

get_sorter_description

run_sorter

run_sorter_jobs

run_sorter_by_property

read_sorter_folder

Low level

spikeinterface.sorters

BaseSorter

spikeinterface.comparison

spikeinterface.comparison

compare_two_sorters

compare_multiple_sorters

compare_sorter_to_ground_truth

compare_templates

compare_multiple_templates

create_hybrid_units_recording

create_hybrid_spikes_recording

GroundTruthComparison

SymmetricSortingComparison

GroundTruthStudy

MultiSortingComparison

CollisionGTComparison

CorrelogramGTComparison

CollisionGTStudy

CorrelogramGTStudy

spikeinterface.widgets

spikeinterface.widgets

set_default_plotter_backend

get_default_plotter_backend

plot_agreement_matrix

plot_all_amplitudes_distributions

plot_amplitudes

plot_autocorrelograms

plot_confusion_matrix

plot_comparison_collision_by_similarity

plot_crosscorrelograms

plot_isi_distribution

plot_motion

plot_multicomparison_agreement

plot_multicomparison_agreement_by_sorter

plot_multicomparison_graph

plot_peak_activity

plot_probe_map

plot_quality_metrics

plot_rasters

plot_sorting_summary

plot_spike_locations

plot_spikes_on_traces

plot_template_metrics

plot_template_similarity

plot_traces

plot_unit_depths

plot_unit_locations

plot_unit_presence

plot_unit_probe_map

plot_unit_summary

plot_unit_templates

plot_unit_waveforms_density_map

plot_unit_waveforms

plot_study_run_times

plot_study_unit_counts

plot_study_performances

plot_study_agreement_matrix

plot_study_summary

plot_study_comparison_collision_by_similarity

spikeinterface.exporters

spikeinterface.exporters

export_to_phy

export_report

spikeinterface.curation

spikeinterface.curation

CurationSorting

MergeUnitsSorting

SplitUnitSorting

get_potential_auto_merge

find_redundant_units

remove_redundant_units

remove_duplicated_spikes

remove_excess_spikes

apply_sortingview_curation

spikeinterface.generation

spikeinterface.generation

make_linear_displacement

move_dense_templates

interpolate_templates

DriftingTemplates

InjectDriftingTemplatesRecording

spikeinterface.sortingcomponents

Peak Localization

spikeinterface.sortingcomponents.peak_localization

localize_peaks

Peak Detection

spikeinterface.sortingcomponents.peak_detection

detect_peaks

Motion Correction

spikeinterface.sortingcomponents.motion_interpolation

InterpolateMotionRecording

Clustering

spikeinterface.sortingcomponents.clustering

find_cluster_from_peaks

Template Matching

spikeinterface.sortingcomponents.matching

find_spikes_from_templates