Skip to content

Add documentation note on manual sampling rate calculations #88

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

Merged
stevevanhooser merged 1 commit into from
Nov 25, 2025
Merged

Add documentation note on manual sampling rate calculations #88

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
10 changes: 10 additions & 0 deletions docs/notes/samplingRateNotes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Sampling Rate Manual Calculation Notes

The following locations in the code perform manual sample-to-time or time-to-sample conversions assuming a constant sampling rate and no gaps. These should eventually be migrated to use `ndr.time.fun.samples2times` or `ndr.reader.base.samples2times`.

| Class | Method | Line Number | Code Snippet |
|---|---|---|---|
| `ndr.reader.ced_smr` | `readchannels_epochsamples` | 91 | `t0 = (s0-1)/sr;` |
| `ndr.reader.intan_rhd` | `t0_t1` | 156 | `total_time = total_samples / header.frequency_parameters.amplifier_sample_rate;` |
| `ndr.reader.intan_rhd` | `readchannels_epochsamples` | 288 | `t0 = (s0-1)/sr;` |
| `ndr.reader.spikegadgets_rec` | `t0_t1` | 169 | `total_time = (total_samples - 1) / str2num(fileconfig.samplingRate);` |
Loading