bluecellulab 2.5.0__py3-none-any.whl → 2.6.38__py3-none-any.whl

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:
@@ -39,38 +43,38 @@ class Stimulus(ABC):
         ax.set_title(self.__class__.__name__)
         return ax
 
-    def plot_during_simulation(self, duration: float, ax=None, **kwargs):
-        if ax is None:
-            ax = plt.gca()
-        # Create an array for the entire duration
-        full_time = np.arange(0, duration, self.dt)
-        full_current = np.zeros_like(full_time)
-
-        # Replace the corresponding values with self.time and self.current
-        indices = (self.time / self.dt).astype(int)
-        full_current[indices] = self.current
-
-        ax.plot(full_time, full_current, **kwargs)
-        ax.set_xlabel("Time (ms)")
-        ax.set_ylabel("Current (nA)")
-        ax.set_title(self.__class__.__name__)
-        ax.set_xlim(0, duration)
-        return ax
-
     def __add__(self, other: Stimulus) -> CombinedStimulus:
         """Override + operator to concatenate Stimulus objects."""
         if self.dt != other.dt:
-            raise ValueError("Stimulus objects must have the same dt to be concatenated")
-        # shift other time
-        other_time = other.time + self.time[-1] + self.dt
-        combined_time = np.concatenate([self.time, other_time])
-        # Concatenate the current arrays
-        combined_current = np.concatenate([self.current, other.current])
-        return CombinedStimulus(self.dt, combined_time, combined_current)
+            raise ValueError(
+                "Stimulus objects must have the same dt to be concatenated"
+            )
+        if len(self.time) == 0:
+            return CombinedStimulus(other.dt, other.time, other.current)
+        elif len(other.time) == 0:
+            return CombinedStimulus(self.dt, self.time, self.current)
+        else:
+            # shift other time
+            other_time = other.time + self.time[-1] + self.dt
+            combined_time = np.concatenate([self.time, other_time])
+            # Concatenate the current arrays
+            combined_current = np.concatenate([self.current, other.current])
+            return CombinedStimulus(self.dt, combined_time, combined_current)
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, Stimulus):
+            return NotImplemented
+        else:
+            return (
+                np.allclose(self.time, other.time)
+                and np.allclose(self.current, other.current)
+                and self.dt == other.dt
+            )
 
 
 class CombinedStimulus(Stimulus):
     """Represents the Stimulus created by combining multiple stimuli."""
+
     def __init__(self, dt: float, time: np.ndarray, current: np.ndarray) -> None:
         super().__init__(dt)
         self._time = time
@@ -85,11 +89,12 @@ class CombinedStimulus(Stimulus):
         return self._current
 
 
-class EmptyStimulus(Stimulus):
+class Empty(Stimulus):
     """Represents empty stimulus (all zeros) that has no impact on the cell.
 
     This is required by some Stimuli that expect the cell to rest.
     """
+
     def __init__(self, dt: float, duration: float) -> None:
         super().__init__(dt)
         self.duration = duration
@@ -103,152 +108,582 @@ class EmptyStimulus(Stimulus):
         return np.zeros_like(self.time)
 
 
-class Step(Stimulus):
-    def __init__(self, dt: float, start: float, end: float, amplitude: float) -> None:
+class Flat(Stimulus):
+    def __init__(self, dt: float, duration: float, amplitude: float) -> None:
         super().__init__(dt)
-        self.start = start
-        self.end = end
+        self.duration = duration
         self.amplitude = amplitude
 
-    @classmethod
-    def threshold_based(
-        cls,
-        dt: float,
-        threshold_current: float,
-        threshold_percentage: float,
-        start: float,
-        end: float,
-        post_wait: float,
-    ) -> CombinedStimulus:
-        amplitude = threshold_current * threshold_percentage / 100
-        res = cls(dt, start, end, amplitude) + EmptyStimulus(dt, duration=post_wait)
-        return res
-
     @property
     def time(self) -> np.ndarray:
-        return np.arange(self.start, self.end, self.dt)
+        return np.arange(0.0, self.duration, self.dt)
 
     @property
     def current(self) -> np.ndarray:
         return np.full_like(self.time, self.amplitude)
 
 
-class Ramp(Stimulus):
+class Slope(Stimulus):
     def __init__(
-        self,
-        dt: float,
-        start: float,
-        end: float,
-        amplitude_start: float,
-        amplitude_end: float,
+        self, dt: float, duration: float, amplitude_start: float, amplitude_end: float
     ) -> None:
         super().__init__(dt)
-        self.start = start
-        self.end = end
+        self.duration = duration
         self.amplitude_start = amplitude_start
         self.amplitude_end = amplitude_end
 
     @property
     def time(self) -> np.ndarray:
-        return np.arange(self.start, self.end, self.dt)
+        return np.arange(0.0, self.duration, self.dt)
 
     @property
     def current(self) -> np.ndarray:
         return np.linspace(self.amplitude_start, self.amplitude_end, len(self.time))
 
 
+class Zap(Stimulus):
+    def __init__(self, dt: float, duration: float, amplitude: float) -> None:
+        super().__init__(dt)
+        self.duration = duration
+        self.amplitude = amplitude
+
+    @property
+    def time(self) -> np.ndarray:
+        return np.arange(0.0, self.duration, self.dt)
+
+    @property
+    def current(self) -> np.ndarray:
+        return self.amplitude * np.sin(
+            2.0 * np.pi * (1.0 + (1.0 / (5.15 - (self.time - 0.1)))) * (self.time - 0.1)
+        )
+
+
+class Step(Stimulus):
+
+    def __init__(self):
+        raise NotImplementedError(
+            "This class cannot be instantiated directly. "
+            "Please use the class methods 'amplitude_based' "
+            "or 'threshold_based' to create objects."
+        )
+
+    @classmethod
+    def amplitude_based(
+        cls,
+        dt: float,
+        pre_delay: float,
+        duration: float,
+        post_delay: float,
+        amplitude: float,
+    ) -> CombinedStimulus:
+        """Create a Step stimulus from given time events and amplitude.
+
+        Args:
+            dt: The time step of the stimulus.
+            pre_delay: The delay before the start of the step.
+            duration: The duration of the step.
+            post_delay: The time to wait after the end of the step.
+            amplitude: The amplitude of the step.
+        """
+        return (
+            Empty(dt, duration=pre_delay)
+            + Flat(dt, duration=duration, amplitude=amplitude)
+            + Empty(dt, duration=post_delay)
+        )
+
+    @classmethod
+    def threshold_based(
+        cls,
+        dt: float,
+        pre_delay: float,
+        duration: float,
+        post_delay: float,
+        threshold_current: float,
+        threshold_percentage: float,
+    ) -> CombinedStimulus:
+        """Creates a Step stimulus with respect to the threshold current.
+
+        Args:
+
+            dt: The time step of the stimulus.
+            pre_delay: The delay before the start of the step.
+            duration: The duration of the step.
+            post_delay: The time to wait after the end of the step.
+            threshold_current: The threshold current of the Cell.
+            threshold_percentage: Percentage of desired threshold_current amplification.
+        """
+        amplitude = threshold_current * threshold_percentage / 100
+        res = cls.amplitude_based(
+            dt,
+            pre_delay=pre_delay,
+            duration=duration,
+            post_delay=post_delay,
+            amplitude=amplitude,
+        )
+        return res
+
+
+class Ramp(Stimulus):
+
+    def __init__(self):
+        raise NotImplementedError(
+            "This class cannot be instantiated directly. "
+            "Please use the class methods 'amplitude_based' "
+            "or 'threshold_based' to create objects."
+        )
+
+    @classmethod
+    def amplitude_based(
+        cls,
+        dt: float,
+        pre_delay: float,
+        duration: float,
+        post_delay: float,
+        amplitude: float,
+    ) -> CombinedStimulus:
+        """Create a Ramp stimulus from given time events and amplitudes.
+
+        Args:
+            dt: The time step of the stimulus.
+            pre_delay: The delay before the start of the ramp.
+            duration: The duration of the ramp.
+            post_delay: The time to wait after the end of the ramp.
+            amplitude: The final amplitude of the ramp.
+        """
+        return (
+            Empty(dt, duration=pre_delay)
+            + Slope(
+                dt,
+                duration=duration,
+                amplitude_start=0.0,
+                amplitude_end=amplitude,
+            )
+            + Empty(dt, duration=post_delay)
+        )
+
+    @classmethod
+    def threshold_based(
+        cls,
+        dt: float,
+        pre_delay: float,
+        duration: float,
+        post_delay: float,
+        threshold_current: float,
+        threshold_percentage: float,
+    ) -> CombinedStimulus:
+        """Creates a Ramp stimulus with respect to the threshold current.
+
+        Args:
+
+            dt: The time step of the stimulus.
+            pre_delay: The delay before the start of the ramp.
+            duration: The duration of the ramp.
+            post_delay: The time to wait after the end of the ramp.
+            threshold_current: The threshold current of the Cell.
+            threshold_percentage: Percentage of desired threshold_current amplification.
+        """
+        amplitude = threshold_current * threshold_percentage / 100
+        res = cls.amplitude_based(
+            dt,
+            pre_delay=pre_delay,
+            duration=duration,
+            post_delay=post_delay,
+            amplitude=amplitude,
+        )
+        return res
+
+
+class DelayedZap(Stimulus):
+
+    def __init__(self):
+        raise NotImplementedError(
+            "This class cannot be instantiated directly. "
+            "Please use the class methods 'amplitude_based' "
+            "or 'threshold_based' to create objects."
+        )
+
+    @classmethod
+    def amplitude_based(
+        cls,
+        dt: float,
+        pre_delay: float,
+        duration: float,
+        post_delay: float,
+        amplitude: float,
+    ) -> CombinedStimulus:
+        """Create a DelayedZap stimulus from given time events and amplitude.
+
+        Args:
+            dt: The time step of the stimulus.
+            pre_delay: The delay before the start of the step.
+            duration: The duration of the step.
+            post_delay: The time to wait after the end of the step.
+            amplitude: The amplitude of the step.
+        """
+        return (
+            Empty(dt, duration=pre_delay)
+            + Zap(dt, duration=duration, amplitude=amplitude)
+            + Empty(dt, duration=post_delay)
+        )
+
+    @classmethod
+    def threshold_based(
+        cls,
+        dt: float,
+        pre_delay: float,
+        duration: float,
+        post_delay: float,
+        threshold_current: float,
+        threshold_percentage: float,
+    ) -> CombinedStimulus:
+        """Creates a SineSpec stimulus with respect to the threshold current.
+
+        Args:
+
+            dt: The time step of the stimulus.
+            pre_delay: The delay before the start of the step.
+            duration: The duration of the step.
+            post_delay: The time to wait after the end of the step.
+            threshold_current: The threshold current of the Cell.
+            threshold_percentage: Percentage of desired threshold_current amplification.
+        """
+        amplitude = threshold_current * threshold_percentage / 100
+        res = cls.amplitude_based(
+            dt,
+            pre_delay=pre_delay,
+            duration=duration,
+            post_delay=post_delay,
+            amplitude=amplitude,
+        )
+        return res
+
+
 class StimulusFactory:
     def __init__(self, dt: float):
         self.dt = dt
 
-    def step(self, start: float, end: float, amplitude: float) -> Stimulus:
-        return Step(self.dt, start, end, amplitude)
+    def step(
+        self, pre_delay: float, duration: float, post_delay: float, amplitude: float
+    ) -> Stimulus:
+        return Step.amplitude_based(
+            self.dt,
+            pre_delay=pre_delay,
+            duration=duration,
+            post_delay=post_delay,
+            amplitude=amplitude,
+        )
 
     def ramp(
-        self, start: float, end: float, amplitude_start: float, amplitude_end: float
+        self, pre_delay: float, duration: float, post_delay: float, amplitude: float
     ) -> Stimulus:
-        return Ramp(self.dt, start, end, amplitude_start, amplitude_end)
+        return Ramp.amplitude_based(
+            self.dt,
+            pre_delay=pre_delay,
+            duration=duration,
+            post_delay=post_delay,
+            amplitude=amplitude,
+        )
 
     def ap_waveform(
         self,
-        threshold_current: float,
-        threshold_percentage: float = 220.0,
-        start: float = 250.0,
-        end: float = 300.0,
-        post_wait: float = 250.0,
+        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.
-            start: The start time of the step.
-            end: The end time of the step.
-            post_wait: The time to wait after the end of the step.
+            amplitude: Raw amplitude of input current.
         """
-        return Step.threshold_based(
-            self.dt, threshold_current, threshold_percentage, start, end, post_wait
-        )
+        pre_delay = 250.0
+        duration = 50.0
+        post_delay = 250.0
+
+        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,
-        start: float = 250.0,
-        end: float = 1600.0,
-        post_wait: float = 250.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.
-            start: The start time of the step.
-            end: The end time of the step.
-            post_wait: The time to wait after the end of the step.
+            amplitude: Raw amplitude of input current.
         """
-        return Step.threshold_based(
-            self.dt, threshold_current, threshold_percentage, start, end, post_wait
-        )
+        pre_delay = 250.0
+        duration = 1350.0
+        post_delay = 250.0
+
+        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,
-        start: float = 250.0,
-        end: float = 3250.0,
-        post_wait: float = 250.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.
-            start: The start time of the step.
-            end: The end time of the step.
-            post_wait: The time to wait after the end of the step.
+            amplitude: Raw amplitude of input current.
         """
-        return Step.threshold_based(
-            self.dt, threshold_current, threshold_percentage, start, end, post_wait
-        )
+        pre_delay = 250.0
+        duration = 3000.0
+        post_delay = 250.0
+
+        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,
-        start: float = 250.0,
-        end: float = 3850.0,
-        post_wait: float = 250.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.
-            start: The start time of the step.
-            end: The end time of the step.
-            post_wait: The time to wait after the end of the step.
+            amplitude: Raw amplitude of input current.
+        """
+        pre_delay = 250.0
+        duration = 3600.0
+        post_delay = 250.0
+
+        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: 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.
+
+        Args:
+            threshold_current: The threshold current of the Cell.
+            threshold_percentage: Percentage of desired threshold_current amplification.
+            amplitude: Raw amplitude of input current.
         """
-        return Step.threshold_based(
-            self.dt, threshold_current, threshold_percentage, start, end, post_wait
+        delay = 250.0
+        ramp1_duration = 4000.0
+        ramp2_duration = 2000.0
+        ramp3_duration = 1333.0
+        inter_delay = 2000.0
+        post_delay = 250.0
+
+        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)
+            + Slope(self.dt, duration=ramp1_duration, amplitude_start=amplitude, amplitude_end=0.0)
+            + Empty(self.dt, duration=inter_delay)
+            + Slope(self.dt, duration=ramp2_duration, amplitude_start=0.0, amplitude_end=amplitude)
+            + Slope(self.dt, duration=ramp2_duration, amplitude_start=amplitude, amplitude_end=0.0)
+            + Empty(self.dt, duration=inter_delay)
+            + Slope(self.dt, duration=ramp3_duration, amplitude_start=0.0, amplitude_end=amplitude)
+            + Slope(self.dt, duration=ramp3_duration, amplitude_start=amplitude, amplitude_end=0.0)
+            + Empty(self.dt, duration=post_delay)
         )
+        return result
+
+    def neg_cheops(
+        self,
+        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.
+
+        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
+        ramp2_duration = 1666.0
+        ramp3_duration = 1111.0
+        inter_delay = 2000.0
+        post_delay = 250.0
+
+        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)
+            + Slope(self.dt, duration=ramp1_duration, amplitude_start=amplitude, amplitude_end=0.0)
+            + Empty(self.dt, duration=inter_delay)
+            + Slope(self.dt, duration=ramp2_duration, amplitude_start=0.0, amplitude_end=amplitude)
+            + Slope(self.dt, duration=ramp2_duration, amplitude_start=amplitude, amplitude_end=0.0)
+            + Empty(self.dt, duration=inter_delay)
+            + Slope(self.dt, duration=ramp3_duration, amplitude_start=0.0, amplitude_end=amplitude)
+            + Slope(self.dt, duration=ramp3_duration, amplitude_start=amplitude, amplitude_end=0.0)
+            + Empty(self.dt, duration=post_delay)
+        )
+        return result
+
+    def sinespec(
+        self,
+        threshold_current: Optional[float] = None,
+        threshold_percentage: Optional[float] = 60.0,
+        amplitude: Optional[float] = None,
+        pre_delay: float = 0,
+    ) -> Stimulus:
+        """Returns the SineSpec Stimulus object, a type of Zap 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: delay before the start of the stimulus
+        """
+        duration = 5000.0
+        post_delay = 0
+
+        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 sinespec."
+                    " Will only keep amplitude value."
+                )
+            return DelayedZap.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 DelayedZap.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")