NeurodataWithoutBorders / pynwb

A Python API for working with Neurodata stored in the NWB Format
https://pynwb.readthedocs.io
Other
178 stars 84 forks source link

[Documentation]: add documentation example for SpikeEventSeries #1937

Closed stephprince closed 3 weeks ago

stephprince commented 4 months ago

What would you like changed or added to the documentation and why?

As discussed in the NWB meeting today, SpikeEventSeries is not well documented.

SpikeEventSeries is meant to store snapshots/snippets of recorded spike events, e.g., threshold crossings of high-pass filtered voltage data in extracellular electrophysiology, which may be detected by ephys hardware or computed during spike sorting. This data type is briefly mentioned in the ecephys tutorial as a way to store waveform snippets.

I propose we add a short example to the Extracellular Electrophysiology Data tutorial demonstrating how to use this data type, since this tutorial covers other ways of designating and storing different types of electrophysiological data.

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct