minor cleanup

Author: SBlokhuizen

waveform_editor/tendencies/base.py

@@ -113,26 +113,30 @@ def set_next_tendency(self, next_tendency):
 
     @depends("values_changed", watch=True)
     def _calc_start_end_values(self):
-        _, start_value_array = self.get_value(np.array([self.start]))
-        self.start_value = start_value_array[0]
-        start_derivative_array = self.get_derivative(np.array([self.start]))
-        self.start_derivative = start_derivative_array[0]
+        """Calculate the values, as well as the derivatives, at the start and end
+        of the tendency.
+        """
+        self.start_value, self.start_derivative = self._get_value_and_derivative(
+            self.start
+        )
+        self.end_value, self.end_derivative = self._get_value_and_derivative(self.end)
 
-        _, end_value_array = self.get_value(np.array([self.end]))
-        self.end_value = end_value_array[0]
-        end_derivative_array = self.get_derivative(np.array([self.end]))
-        self.end_derivative = end_derivative_array[0]
+    def _get_value_and_derivative(self, time):
+        """Get the value and derivative of the tendency at a given time."""
+        _, value_array = self.get_value(np.array([time]))
+        derivative_array = self.get_derivative(np.array([time]))
+        return value_array[0], derivative_array[0]
 
     @abstractmethod
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Get the values on the provided time array."""
+        """Get the tendency values at the provided time array."""
         return np.array([0]), np.array([0])
 
     @abstractmethod
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array."""
+        """Get the values of the derivatives at the provided time array."""
         return np.array([0])
 
     @depends(

waveform_editor/tendencies/constant.py

@@ -24,8 +24,8 @@ def __init__(self, **kwargs):
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Get the values of the provided time array. If no time array is provided,
-        a constant line containing the start and end points will be generated.
+        """Get the tendency values at the provided time array. If no time array is
+        provided, a constant line containing the start and end points will be generated.
 
         Args:
             time: The time array on which to generate points.
@@ -39,7 +39,7 @@ def get_value(
         return time, values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.

waveform_editor/tendencies/linear.py

@@ -38,8 +38,8 @@ def __init__(self, **kwargs):
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Get the values onf the provided time array. If no time array is provided,
-        a line containing the start and end points will be generated.
+        """Get the tendency values at the provided time array. If no time array is
+        provided, a line containing the start and end points will be generated.
 
         Args:
             time: The time array on which to generate points.
@@ -54,7 +54,7 @@ def get_value(
         return time, values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.

waveform_editor/tendencies/periodic/sawtooth_wave.py

@@ -11,9 +11,10 @@ class SawtoothWaveTendency(PeriodicBaseTendency):
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Generate time and values based on the tendency. If no time array is provided,
-        a time array will be created from the start to the end of the tendency, where
-        time points are defined for every peak and trough in the tendency.
+        """Get the tendency values at the provided time array. If no time array is
+        provided, a time array will be created from the start to the end of the
+        tendency, where time points are defined for every peak and trough in the
+        tendency.
 
         Args:
             time: The time array on which to generate points.
@@ -29,7 +30,7 @@ def get_value(
         return time, values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.

waveform_editor/tendencies/periodic/sine_wave.py

@@ -11,9 +11,9 @@ class SineWaveTendency(PeriodicBaseTendency):
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Generate time and values based on the tendency. If no time array is provided,
-        a linearly spaced time array will be generated from the start to the end of the
-        tendency.
+        """Get the tendency values at the provided time array. If no time array is
+        provided, a linearly spaced time array will be generated from the start to the
+        end of the tendency.
 
         Args:
             time: The time array on which to generate points.
@@ -29,7 +29,7 @@ def get_value(
         return time, values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.

waveform_editor/tendencies/periodic/square_wave.py

@@ -11,9 +11,10 @@ class SquareWaveTendency(PeriodicBaseTendency):
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Generate time and values based on the tendency. If no time array is provided,
-        a time array will be created from the start to the end of the tendency, where
-        time points are defined for every peak and trough in the tendency.
+        """Get the tendency values at the provided time array. If no time array is
+        provided, a time array will be created from the start to the end of the
+        tendency, where time points are defined for every peak and trough in the
+        tendency.
 
         Args:
             time: The time array on which to generate points.
@@ -29,7 +30,7 @@ def get_value(
         return time, values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.

waveform_editor/tendencies/periodic/triangle_wave.py

@@ -11,9 +11,10 @@ class TriangleWaveTendency(PeriodicBaseTendency):
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Generate time and values based on the tendency. If no time array is provided,
-        a time array will be created from the start to the end of the tendency, where
-        time points are defined for every peak and trough in the tendency.
+        """Get the tendency values at the provided time array. If no time array is
+        provided, a time array will be created from the start to the end of the
+        tendency, where time points are defined for every peak and trough in the
+        tendency.
 
         Args:
             time: The time array on which to generate points.
@@ -27,7 +28,7 @@ def get_value(
         return time, values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.

waveform_editor/tendencies/piecewise.py

@@ -29,8 +29,9 @@ def __init__(self, *, user_time=None, user_value=None):
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Generate time and values based on the tendency. If a time array is provided,
-        the values will be linearly interpolated between the piecewise linear points.
+        """Get the tendency values at the provided time array. If a time array is
+        provided, the values will be linearly interpolated between the piecewise linear
+        points.
 
         Args:
             time: The time array on which to generate points.
@@ -39,14 +40,14 @@ def get_value(
             Tuple containing the time and its tendency values.
         """
         if time is None:
-            time = self.time
+            return self.time, self.value
 
         self._validate_requested_time(time)
         interpolated_values = np.interp(time, self.time, self.value)
         return time, interpolated_values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.
@@ -55,17 +56,14 @@ def get_derivative(self, time: np.ndarray) -> np.ndarray:
             numpy array containing the derivatives
         """
         self._validate_requested_time(time)
-
         derivatives = np.zeros_like(time)
 
         for i, t in enumerate(time):
-            # Find the segment for this particular time
             if t == self.time[-1]:
                 derivatives[i] = (self.value[-1] - self.value[-2]) / (
                     self.time[-1] - self.time[-2]
                 )
             else:
-                # Find the two indices surrounding the time point (t)
                 index = np.searchsorted(self.time, t)
                 dv = self.value[index + 1] - self.value[index]
                 dt = self.time[index + 1] - self.time[index]
@@ -74,6 +72,11 @@ def get_derivative(self, time: np.ndarray) -> np.ndarray:
         return derivatives
 
     def _validate_requested_time(self, time):
+        """Check if the requested time data falls within the piecewise tendency.
+
+        Args:
+            time: The time array on which to generate points.
+        """
         if np.any(time < self.time[0]) or np.any(time > self.time[-1]):
             raise ValueError(
                 f"The provided time array contains values outside the valid range "

waveform_editor/tendencies/repeat.py

@@ -42,14 +42,14 @@ def __init__(self, **kwargs):
         #   - {type: linear, from: 2, to: 0, duration: 1}
         #   - {type: smooth, duration: 3}
         #
-        # Here, the smooth tendency would smoothly interpolate from 0 to 2
+        # where, the smooth tendency would smoothly interpolate from 0 to 2
 
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Generate time and values based on the tendency. If no time array is provided,
-        the individual tendencies are responsible for creating a time array, and these
-        are appended.
+        """Get the tendency values at the provided time array. If no time array is
+        provided, the individual tendencies are responsible for creating a time array,
+        and these are appended.
 
         Args:
             time: The time array on which to generate points.
@@ -73,17 +73,18 @@ def get_value(
             values = values[: cut_index + 1]
             if times[-1] != self.end:
                 times[-1] = self.end
-                _, values[-1] = self.waveform.get_value(
+                _, end_array = self.waveform.get_value(
                     np.array([(self.end - self.start) % length])
                 )
+                values[-1] = end_array[0]
         else:
             times = np.atleast_1d(time)
             relative_times = (times - self.start) % length
             _, values = self.waveform.get_value(relative_times)
         return times, values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.
@@ -92,7 +93,6 @@ def get_derivative(self, time: np.ndarray) -> np.ndarray:
             numpy array containing the derivatives
         """
         length = self.waveform.calc_length()
-        times = np.atleast_1d(time)
-        relative_times = (times - self.start) % length
+        relative_times = (time - self.start) % length
         derivatives = self.waveform.get_derivative(relative_times)
         return derivatives

waveform_editor/tendencies/smooth.py

@@ -32,9 +32,9 @@ def __init__(self, **kwargs):
     def get_value(
         self, time: Optional[np.ndarray] = None
     ) -> tuple[np.ndarray, np.ndarray]:
-        """Generate time and values based on the tendency. If no time array is provided,
-        a linearly spaced time array will be generated from the start to the end of the
-        tendency.
+        """Get the tendency values at the provided time array. If no time array is
+        provided, a linearly spaced time array will be generated from the start to the
+        end of the tendency.
 
         Args:
             time: The time array on which to generate points.
@@ -56,7 +56,7 @@ def get_value(
         return time, values
 
     def get_derivative(self, time: np.ndarray) -> np.ndarray:
-        """Get the derivative values on the provided time array.
+        """Get the values of the derivatives at the provided time array.
 
         Args:
             time: The time array on which to generate points.