agencyenterprise / neural-data-simulator

Electrophysiology data simulator for developing brain-computer interfaces
https://agencyenterprise.github.io/neural-data-simulator/
Apache License 2.0
71 stars 7 forks source link

Make waveforms optional for `Spikes` API #36

Closed charlesbmi closed 1 year ago

charlesbmi commented 1 year ago

https://github.com/agencyenterprise/neural-data-simulator/issues/30

Introduction

User feedback:

I had a use case where I used the Spikes class to generate fake spikes so I could check the statistics of the fake vs real spikes. I didn’t need waveforms so factoring Spikes into something that doesn’t depend on waveforms (or only optionally does)... would be great.

This is a common use-case: the user may not want to use the compute-power to simulate full-bandwidth ephys signals and may only be interested in the spike times.

Changes

Behavior

codecov-commenter commented 1 year ago

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Files Coverage Δ
...ural_data_simulator/scripts/run_ephys_generator.py 87.09% <ø> (ø)
src/neural_data_simulator/ephys_generator.py 74.92% <83.33%> (+0.08%) :arrow_up:

:loudspeaker: Thoughts on this report? Let us know!.