SpikeInterface / SpikeInterface/spikeinterface
Understanding how Spikeinterface handles recording times.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 847
- Forks
- 280
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 29
Description
I always thought that SI was essentially time-agnostic and computed times on the fly based on sample number and sampling rate. However I had the same experience as @yger when reading this thread and was surprised time information is tracked.
I just seen this docs page which introduces the concept which is great, I had not seen it before. However it might still be useful to flesh it out a bit and add what happens in certain scenarios e.g. 1) slicing recording 2) concatenate recording 3) appending / concatenating segments.
I'd be happy to do this ASAP (just (hopefully 🤞 ) finishing off an unrelated project and will have more time for ephys). But I thought I'd get the ball rolling here in case there are other cases I had not considered.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Handle Times documentation page linked in the issue and review the existing explanation of recording times. Expand it to cover slicing recordings, concatenating recordings, and appending or concatenating segments, with the documentation clearly explaining what happens in each scenario.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100