fix bug where sample period couldn't be passed in for RWSLFPSignalFromPSCs

Author: kjohnsen

cleo/ephys/lfp.py

@@ -612,7 +612,7 @@ def connect_to_neuron_group(self, neuron_group: NeuronGroup, **kwparams):
         self._init_wslfp_calc(neuron_group, **kwparams)
 
         buf_len_ampa, buf_len_gaba = self._get_buf_lens_for_wslfp(
-            self._wslfps[neuron_group]
+            self._wslfps[neuron_group], **kwparams
         )
         self._t_ampa_bufs[neuron_group] = deque(maxlen=buf_len_ampa)
         self._I_ampa_bufs[neuron_group] = deque(maxlen=buf_len_ampa)
@@ -633,7 +633,7 @@ def _get_buf_lens_for_wslfp(self, wslfp_calc, **kwparams):
             try:
                 sample_period = self.probe.sim.io_processor.sample_period
             except AttributeError:  # probably means sim doesn't have io_processor
-                raise Exception(
+                raise RuntimeError(
                     "RSWLFPSignalFromPSCs needs to know the sampling period."
                     " Either set the simulator's IO processor before injecting"
                     f" {self.probe.name} or "

tests/ephys/test_lfp.py

@@ -369,6 +369,7 @@ def add_rwslfp_sig(
         Iampa_var_names=["Iampa1"],
         Igaba_var_names=["Igaba1"],
         name=None,
+        inject_kwargs={},
     ):
         rwslfp_sig = RWSLFPSignalFromPSCs(
             pop_aggregate=pop_agg,
@@ -387,6 +388,7 @@ def add_rwslfp_sig(
             orientation=ornt,
             Iampa_var_names=Iampa_var_names,
             Igaba_var_names=Igaba_var_names,
+            **inject_kwargs,
         )
         return rwslfp_sig
 
@@ -416,6 +418,13 @@ def add_rwslfp_sig(
                     f"{sig1.name} and {sig2.name} not yielding different results"
                 )
 
+    # test missing sampling period error
+    sim.set_io_processor(None)
+    print(sim.io_processor)
+    with pytest.raises(RuntimeError, match="needs to know the sampling period"):
+        add_rwslfp_sig()
+    add_rwslfp_sig(inject_kwargs={"sample_period": 5 * ms})
+
 
 def test_psc_buffer():
     sig = RWSLFPSignalFromPSCs()