bluecellulab 2.6.13__py3-none-any.whl → 2.6.14__py3-none-any.whl

bluecellulab/analysis/inject_sequence.py

@@ -74,6 +74,7 @@ def apply_multiple_stimuli(
     cell: Cell,
     stimulus_name: StimulusName,
     amplitudes: Sequence[float],
+    threshold_based: bool = True,
     section_name: str | None = None,
     segment: float = 0.5,
     n_processes: int | None = None,
@@ -84,6 +85,8 @@ def apply_multiple_stimuli(
         cell: The cell to which the stimuli are applied.
         stimulus_name: The name of the stimulus to apply.
         amplitudes: The amplitudes of the stimuli to apply.
+        threshold_based: Whether to consider amplitudes to be
+            threshold percentages or to be raw amplitudes.
         section_name: Section name of the cell where the stimuli are applied.
           If None, the stimuli are applied at the soma[0] of the cell.
         segment: The segment of the section where the stimuli are applied.
@@ -103,18 +106,37 @@ def apply_multiple_stimuli(
 
     # Prepare arguments for each stimulus
     for amplitude in amplitudes:
+        if threshold_based:
+            thres_perc = amplitude
+            amp = None
+        else:
+            thres_perc = None
+            amp = amplitude
+
         if stimulus_name == StimulusName.AP_WAVEFORM:
-            stimulus = stim_factory.ap_waveform(threshold_current=cell.threshold, threshold_percentage=amplitude)
+            stimulus = stim_factory.ap_waveform(
+                threshold_current=cell.threshold, threshold_percentage=thres_perc, amplitude=amp
+            )
         elif stimulus_name == StimulusName.IDREST:
-            stimulus = stim_factory.idrest(threshold_current=cell.threshold, threshold_percentage=amplitude)
+            stimulus = stim_factory.idrest(
+                threshold_current=cell.threshold, threshold_percentage=thres_perc, amplitude=amp
+            )
         elif stimulus_name == StimulusName.IV:
-            stimulus = stim_factory.iv(threshold_current=cell.threshold, threshold_percentage=amplitude)
+            stimulus = stim_factory.iv(
+                threshold_current=cell.threshold, threshold_percentage=thres_perc, amplitude=amp
+            )
         elif stimulus_name == StimulusName.FIRE_PATTERN:
-            stimulus = stim_factory.fire_pattern(threshold_current=cell.threshold, threshold_percentage=amplitude)
+            stimulus = stim_factory.fire_pattern(
+                threshold_current=cell.threshold, threshold_percentage=thres_perc, amplitude=amp
+            )
         elif stimulus_name == StimulusName.POS_CHEOPS:
-            stimulus = stim_factory.pos_cheops(threshold_current=cell.threshold, threshold_percentage=amplitude)
+            stimulus = stim_factory.pos_cheops(
+                threshold_current=cell.threshold, threshold_percentage=thres_perc, amplitude=amp
+            )
         elif stimulus_name == StimulusName.NEG_CHEOPS:
-            stimulus = stim_factory.neg_cheops(threshold_current=cell.threshold, threshold_percentage=amplitude)
+            stimulus = stim_factory.neg_cheops(
+                threshold_current=cell.threshold, threshold_percentage=thres_perc, amplitude=amp
+            )
         else:
             raise ValueError("Unknown stimulus name.")
 

bluecellulab/stimulus/factory.py

@@ -1,8 +1,12 @@
 from __future__ import annotations
 from abc import ABC, abstractmethod
+from typing import Optional
+import logging
 import matplotlib.pyplot as plt
 import numpy as np
 
+logger = logging.getLogger(__name__)
+
 
 class Stimulus(ABC):
     def __init__(self, dt: float) -> None:
@@ -299,99 +303,182 @@ class StimulusFactory:
         )
 
     def ap_waveform(
-        self, threshold_current: float, threshold_percentage: float = 220.0
+        self,
+        threshold_current: Optional[float] = None,
+        threshold_percentage: Optional[float] = 220.0,
+        amplitude: Optional[float] = None,
     ) -> Stimulus:
         """Returns the APWaveform Stimulus object, a type of Step stimulus.
 
         Args:
             threshold_current: The threshold current of the Cell.
             threshold_percentage: Percentage of desired threshold_current amplification.
+            amplitude: Raw amplitude of input current.
         """
         pre_delay = 250.0
         duration = 50.0
         post_delay = 250.0
-        return Step.threshold_based(
-            self.dt,
-            pre_delay=pre_delay,
-            duration=duration,
-            post_delay=post_delay,
-            threshold_current=threshold_current,
-            threshold_percentage=threshold_percentage,
-        )
+
+        if amplitude is not None:
+            if threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+                logger.info(
+                    "amplitude, threshold_current and threshold_percentage are all set in ap_waveform."
+                    " Will only keep amplitude value."
+                )
+            return Step.amplitude_based(
+                self.dt,
+                pre_delay=pre_delay,
+                duration=duration,
+                post_delay=post_delay,
+                amplitude=amplitude,
+            )
+
+        if threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+            return Step.threshold_based(
+                self.dt,
+                pre_delay=pre_delay,
+                duration=duration,
+                post_delay=post_delay,
+                threshold_current=threshold_current,
+                threshold_percentage=threshold_percentage,
+            )
+
+        raise TypeError("You have to give either threshold_current or amplitude")
 
     def idrest(
         self,
-        threshold_current: float,
-        threshold_percentage: float = 200.0,
+        threshold_current: Optional[float] = None,
+        threshold_percentage: Optional[float] = 200.0,
+        amplitude: Optional[float] = None,
     ) -> Stimulus:
         """Returns the IDRest Stimulus object, a type of Step stimulus.
 
         Args:
             threshold_current: The threshold current of the Cell.
             threshold_percentage: Percentage of desired threshold_current amplification.
+            amplitude: Raw amplitude of input current.
         """
         pre_delay = 250.0
         duration = 1350.0
         post_delay = 250.0
-        return Step.threshold_based(
-            self.dt,
-            pre_delay=pre_delay,
-            duration=duration,
-            post_delay=post_delay,
-            threshold_current=threshold_current,
-            threshold_percentage=threshold_percentage,
-        )
+
+        if amplitude is not None:
+            if threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+                logger.info(
+                    "amplitude, threshold_current and threshold_percentage are all set in idrest."
+                    " Will only keep amplitude value."
+                )
+            return Step.amplitude_based(
+                self.dt,
+                pre_delay=pre_delay,
+                duration=duration,
+                post_delay=post_delay,
+                amplitude=amplitude,
+            )
+
+        if threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+            return Step.threshold_based(
+                self.dt,
+                pre_delay=pre_delay,
+                duration=duration,
+                post_delay=post_delay,
+                threshold_current=threshold_current,
+                threshold_percentage=threshold_percentage,
+            )
+
+        raise TypeError("You have to give either threshold_current or amplitude")
 
     def iv(
         self,
-        threshold_current: float,
-        threshold_percentage: float = -40.0,
+        threshold_current: Optional[float] = None,
+        threshold_percentage: Optional[float] = -40.0,
+        amplitude: Optional[float] = None,
     ) -> Stimulus:
         """Returns the IV Stimulus object, a type of Step stimulus.
 
         Args:
             threshold_current: The threshold current of the Cell.
             threshold_percentage: Percentage of desired threshold_current amplification.
+            amplitude: Raw amplitude of input current.
         """
         pre_delay = 250.0
         duration = 3000.0
         post_delay = 250.0
-        return Step.threshold_based(
-            self.dt,
-            pre_delay=pre_delay,
-            duration=duration,
-            post_delay=post_delay,
-            threshold_current=threshold_current,
-            threshold_percentage=threshold_percentage,
-        )
+
+        if amplitude is not None:
+            if threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+                logger.info(
+                    "amplitude, threshold_current and threshold_percentage are all set in iv."
+                    " Will only keep amplitude value."
+                )
+            return Step.amplitude_based(
+                self.dt,
+                pre_delay=pre_delay,
+                duration=duration,
+                post_delay=post_delay,
+                amplitude=amplitude,
+            )
+
+        if threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+            return Step.threshold_based(
+                self.dt,
+                pre_delay=pre_delay,
+                duration=duration,
+                post_delay=post_delay,
+                threshold_current=threshold_current,
+                threshold_percentage=threshold_percentage,
+            )
+
+        raise TypeError("You have to give either threshold_current or amplitude")
 
     def fire_pattern(
         self,
-        threshold_current: float,
-        threshold_percentage: float = 200.0,
+        threshold_current: Optional[float] = None,
+        threshold_percentage: Optional[float] = 200.0,
+        amplitude: Optional[float] = None,
     ) -> Stimulus:
         """Returns the FirePattern Stimulus object, a type of Step stimulus.
 
         Args:
             threshold_current: The threshold current of the Cell.
             threshold_percentage: Percentage of desired threshold_current amplification.
+            amplitude: Raw amplitude of input current.
         """
         pre_delay = 250.0
         duration = 3600.0
         post_delay = 250.0
-        return Step.threshold_based(
-            self.dt,
-            pre_delay=pre_delay,
-            duration=duration,
-            post_delay=post_delay,
-            threshold_current=threshold_current,
-            threshold_percentage=threshold_percentage,
-        )
+
+        if amplitude is not None:
+            if threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+                logger.info(
+                    "amplitude, threshold_current and threshold_percentage are all set in fire_pattern."
+                    " Will only keep amplitude value."
+                )
+            return Step.amplitude_based(
+                self.dt,
+                pre_delay=pre_delay,
+                duration=duration,
+                post_delay=post_delay,
+                amplitude=amplitude,
+            )
+
+        if threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+            return Step.threshold_based(
+                self.dt,
+                pre_delay=pre_delay,
+                duration=duration,
+                post_delay=post_delay,
+                threshold_current=threshold_current,
+                threshold_percentage=threshold_percentage,
+            )
+
+        raise TypeError("You have to give either threshold_current or amplitude")
 
     def pos_cheops(
         self,
-        threshold_current: float,
-        threshold_percentage: float = 300.0,
+        threshold_current: Optional[float] = None,
+        threshold_percentage: Optional[float] = 300.0,
+        amplitude: Optional[float] = None,
     ) -> Stimulus:
         """A combination of pyramid shaped Ramp stimuli with a positive
         amplitude.
@@ -399,6 +486,7 @@ class StimulusFactory:
         Args:
             threshold_current: The threshold current of the Cell.
             threshold_percentage: Percentage of desired threshold_current amplification.
+            amplitude: Raw amplitude of input current.
         """
         delay = 250.0
         ramp1_duration = 4000.0
@@ -407,7 +495,15 @@ class StimulusFactory:
         inter_delay = 2000.0
         post_delay = 250.0
 
-        amplitude = threshold_current * threshold_percentage / 100
+        if amplitude is None:
+            if threshold_current is None or threshold_current == 0 or threshold_percentage is None:
+                raise TypeError("You have to give either threshold_current or amplitude")
+            amplitude = threshold_current * threshold_percentage / 100
+        elif threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+            logger.info(
+                "amplitude, threshold_current and threshold_percentage are all set in pos_cheops."
+                " Will only keep amplitude value."
+            )
         result = (
             Empty(self.dt, duration=delay)
             + Slope(self.dt, duration=ramp1_duration, amplitude_start=0.0, amplitude_end=amplitude)
@@ -424,8 +520,9 @@ class StimulusFactory:
 
     def neg_cheops(
         self,
-        threshold_current: float,
-        threshold_percentage: float = 300.0,
+        threshold_current: Optional[float] = None,
+        threshold_percentage: Optional[float] = 300.0,
+        amplitude: Optional[float] = None,
     ) -> Stimulus:
         """A combination of pyramid shaped Ramp stimuli with a negative
         amplitude.
@@ -433,6 +530,7 @@ class StimulusFactory:
         Args:
             threshold_current: The threshold current of the Cell.
             threshold_percentage: Percentage of desired threshold_current amplification.
+            amplitude: Raw amplitude of input current.
         """
         delay = 1750.0
         ramp1_duration = 3333.0
@@ -441,7 +539,15 @@ class StimulusFactory:
         inter_delay = 2000.0
         post_delay = 250.0
 
-        amplitude = - threshold_current * threshold_percentage / 100
+        if amplitude is None:
+            if threshold_current is None or threshold_current == 0 or threshold_percentage is None:
+                raise TypeError("You have to give either threshold_current or amplitude")
+            amplitude = - threshold_current * threshold_percentage / 100
+        elif threshold_current is not None and threshold_current != 0 and threshold_percentage is not None:
+            logger.info(
+                "amplitude, threshold_current and threshold_percentage are all set in neg_cheops."
+                " Will only keep amplitude value."
+            )
         result = (
             Empty(self.dt, duration=delay)
             + Slope(self.dt, duration=ramp1_duration, amplitude_start=0.0, amplitude_end=amplitude)

{bluecellulab-2.6.13.dist-info → bluecellulab-2.6.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bluecellulab
-Version: 2.6.13
+Version: 2.6.14
 Summary: Biologically detailed neural network simulations and analysis.
 Author: Blue Brain Project, EPFL
 License: Apache2.0

{bluecellulab-2.6.13.dist-info → bluecellulab-2.6.14.dist-info}/RECORD

@@ -15,7 +15,7 @@ bluecellulab/type_aliases.py,sha256=DvgjERv2Ztdw_sW63JrZTQGpJ0x5uMTFB5hcBHDb0WA,
 bluecellulab/utils.py,sha256=SbOOkzw1YGjCKV3qOw0zpabNEy7V9BRtgMLsQJiFRq4,1526
 bluecellulab/verbosity.py,sha256=T0IgX7DrRo19faxrT4Xzb27gqxzoILQ8FzYKxvUeaPM,1342
 bluecellulab/analysis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bluecellulab/analysis/inject_sequence.py,sha256=Kgs-Be6CtRc9LI1qsM7mC4oGfpW6VrqGPHSuoa7XFYs,5148
+bluecellulab/analysis/inject_sequence.py,sha256=K3166jDTikEMMfRPJvuqfC6VPdUfyK7Ua7_M9Tr6uZg,5738
 bluecellulab/cell/__init__.py,sha256=Sbc0QOsJ8E7tSwf3q7fsXuE_SevBN6ZmoCVyyU5zfII,208
 bluecellulab/cell/cell_dict.py,sha256=PVmZsjhZ9jp3HC-8QmdFqp-crAcVMSVeLWujcOPLlpo,1346
 bluecellulab/cell/core.py,sha256=ZVzy3tsA5X7OyCmnHQn0d6AlNg9rOG2ojKuojvKdsFw,31487
@@ -58,13 +58,13 @@ bluecellulab/simulation/parallel.py,sha256=oQ_oV2EKr8gP4yF2Dq8q9MiblDyi89_wBgLzQ
 bluecellulab/simulation/simulation.py,sha256=I__cZwV_A8I7XSefn6aJDBA_jXCI3E35-pCNCLUsnvo,6206
 bluecellulab/stimulus/__init__.py,sha256=DgIgVaSyR-URf3JZzvO6j-tjCerzvktuK-ep8pjMRPQ,37
 bluecellulab/stimulus/circuit_stimulus_definitions.py,sha256=uij_s44uNdmMwMLGmTHSRgmp9K9B_vvHHshX6YPJNJU,15686
-bluecellulab/stimulus/factory.py,sha256=hoq5JA69eX4bAdtOJNErhBn_p0uQh8QPoFvCqqeGBN4,14874
+bluecellulab/stimulus/factory.py,sha256=XDbnqCuMCh1RdZLKvlRucMj3wkXDqy6mEda_Oh6Yqo4,19955
 bluecellulab/synapse/__init__.py,sha256=RW8XoAMXOvK7OG1nHl_q8jSEKLj9ZN4oWf2nY9HAwuk,192
 bluecellulab/synapse/synapse_factory.py,sha256=MjUorWoMl4lFSBgQw4QS09Dzh0-LYWlCHJKYy8N-d3w,6847
 bluecellulab/synapse/synapse_types.py,sha256=4gne-hve2vq1Lau-LAVPsfLjffVYqAYBW3kCfC7_600,16871
-bluecellulab-2.6.13.dist-info/AUTHORS.txt,sha256=EDs3H-2HXBojbma10psixk3C2rFiOCTIREi2ZAbXYNQ,179
-bluecellulab-2.6.13.dist-info/LICENSE,sha256=xOouu1gC1GGklDxkITlaVl60I9Ab860O-nZsFbWydvU,11749
-bluecellulab-2.6.13.dist-info/METADATA,sha256=pMdxyVSGeRMoo0di8GdJVhrkW_1kd6OTxNOJCbSa8cI,7054
-bluecellulab-2.6.13.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-bluecellulab-2.6.13.dist-info/top_level.txt,sha256=VSyEP8w9l3pXdRkyP_goeMwiNA8KWwitfAqUkveJkdQ,13
-bluecellulab-2.6.13.dist-info/RECORD,,
+bluecellulab-2.6.14.dist-info/AUTHORS.txt,sha256=EDs3H-2HXBojbma10psixk3C2rFiOCTIREi2ZAbXYNQ,179
+bluecellulab-2.6.14.dist-info/LICENSE,sha256=xOouu1gC1GGklDxkITlaVl60I9Ab860O-nZsFbWydvU,11749
+bluecellulab-2.6.14.dist-info/METADATA,sha256=aAFV1ZITbhfPMneiZzSo0Vj4wdBu2dzcGd9sggs1R8I,7054
+bluecellulab-2.6.14.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+bluecellulab-2.6.14.dist-info/top_level.txt,sha256=VSyEP8w9l3pXdRkyP_goeMwiNA8KWwitfAqUkveJkdQ,13
+bluecellulab-2.6.14.dist-info/RECORD,,