Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add read_binary and read_zarr functions to extractord and docs API #2019

Merged
merged 1 commit into from
Sep 19, 2023
Merged

Add read_binary and read_zarr functions to extractord and docs API #2019

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions doc/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ spikeinterface.core
.. autofunction:: extract_waveforms
.. autofunction:: load_waveforms
.. autofunction:: compute_sparsity
.. autoclass:: ChannelSparsity
:members:
.. autoclass:: BinaryRecordingExtractor
.. autoclass:: ZarrRecordingExtractor
.. autoclass:: BinaryFolderRecording
Expand Down Expand Up @@ -48,17 +50,15 @@ spikeinterface.core
.. autofunction:: get_template_extremum_channel
.. autofunction:: get_template_extremum_channel_peak_shift
.. autofunction:: get_template_extremum_amplitude

..
.. autofunction:: read_binary
.. autofunction:: read_zarr
.. autofunction:: append_recordings
.. autofunction:: concatenate_recordings
.. autofunction:: split_recording
.. autofunction:: select_segment_recording
.. autofunction:: append_sortings
.. autofunction:: split_sorting
.. autofunction:: select_segment_sorting
.. autofunction:: read_binary
.. autofunction:: read_zarr

Low-level
~~~~~~~~~
Expand All @@ -67,7 +67,6 @@ Low-level
:noindex:

.. autoclass:: BaseWaveformExtractorExtension
.. autoclass:: ChannelSparsity
.. autoclass:: ChunkRecordingExecutor

spikeinterface.extractors
Expand All @@ -83,6 +82,7 @@ NEO-based
.. autofunction:: read_alphaomega_event
.. autofunction:: read_axona
.. autofunction:: read_biocam
.. autofunction:: read_binary
.. autofunction:: read_blackrock
.. autofunction:: read_ced
.. autofunction:: read_intan
Expand All @@ -104,6 +104,7 @@ NEO-based
.. autofunction:: read_spikegadgets
.. autofunction:: read_spikeglx
.. autofunction:: read_tdt
.. autofunction:: read_zarr


Non-NEO-based
Expand Down
2 changes: 2 additions & 0 deletions src/spikeinterface/extractors/extractorlist.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
NumpySorting,
NpySnippetsExtractor,
ZarrRecordingExtractor,
read_binary,
read_zarr,
)

# sorting/recording/event from neo
Expand Down