Merge pull request #14 from iterorganization/feature/refactor-derivatives

Allow getting derivative at arbitrary time points in tendency

Author: SBlokhuizen

tests/tendencies/periodic/test_periodic_base.py

@@ -1,3 +1,5 @@
+from unittest.mock import patch
+
 import numpy as np
 import pytest
 from pytest import approx
@@ -6,6 +8,16 @@
 from waveform_editor.tendencies.periodic.periodic_base import PeriodicBaseTendency
 
 
+@pytest.fixture(autouse=True)
+def patch_periodic_base_tendency():
+    arr = np.array([0])
+    with (
+        patch.object(PeriodicBaseTendency, "get_value", return_value=(arr, arr)),
+        patch.object(PeriodicBaseTendency, "get_derivative", return_value=arr),
+    ):
+        yield
+
+
 @pytest.mark.parametrize(
     "base, amplitude, min, max, expected_base, expected_amplitude, has_error",
     [

tests/tendencies/periodic/test_sawtooth_wave.py

@@ -11,10 +11,10 @@ def test_start_and_end():
     tendency = SawtoothWaveTendency(
         user_duration=1, user_base=0, user_amplitude=1, user_frequency=1
     )
-    assert tendency.get_start_value() == approx(0)
-    assert tendency.get_end_value() == approx(0)
-    assert tendency.get_derivative_start() == approx(2)
-    assert tendency.get_derivative_end() == approx(2)
+    assert tendency.start_value == approx(0)
+    assert tendency.end_value == approx(0)
+    assert tendency.start_derivative == approx(2)
+    assert tendency.end_derivative == approx(2)
 
     tendency = SawtoothWaveTendency(
         user_duration=1,
@@ -23,10 +23,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=np.pi / 2,
     )
-    assert tendency.get_start_value() == approx(0.5)
-    assert tendency.get_end_value() == approx(0.5)
-    assert tendency.get_derivative_start() == approx(2)
-    assert tendency.get_derivative_end() == approx(2)
+    assert tendency.start_value == approx(0.5)
+    assert tendency.end_value == approx(0.5)
+    assert tendency.start_derivative == approx(2)
+    assert tendency.end_derivative == approx(2)
 
     tendency = SawtoothWaveTendency(
         user_duration=1,
@@ -35,10 +35,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=np.pi / 4,
     )
-    assert tendency.get_start_value() == approx(0.25)
-    assert tendency.get_end_value() == approx(0.25)
-    assert tendency.get_derivative_start() == approx(2)
-    assert tendency.get_derivative_end() == approx(2)
+    assert tendency.start_value == approx(0.25)
+    assert tendency.end_value == approx(0.25)
+    assert tendency.start_derivative == approx(2)
+    assert tendency.end_derivative == approx(2)
 
 
 def test_generate():
@@ -53,6 +53,6 @@ def test_generate():
         user_phase=np.pi / 2,
         user_frequency=1,
     )
-    time, values = tendency.generate()
+    time, values = tendency.get_value()
     assert np.allclose(time, [0, 0.25, 0.25, 1])
     assert np.allclose(values, [4.5, 6, 0, 4.5])

tests/tendencies/periodic/test_sine_wave.py

@@ -11,10 +11,10 @@ def test_start_and_end():
     tendency = SineWaveTendency(
         user_duration=1, user_base=0, user_amplitude=1, user_frequency=1
     )
-    assert tendency.get_start_value() == approx(0)
-    assert tendency.get_end_value() == approx(0)
-    assert tendency.get_derivative_start() == approx(2 * np.pi)
-    assert tendency.get_derivative_end() == approx(2 * np.pi)
+    assert tendency.start_value == approx(0)
+    assert tendency.end_value == approx(0)
+    assert tendency.start_derivative == approx(2 * np.pi)
+    assert tendency.end_derivative == approx(2 * np.pi)
 
     tendency = SineWaveTendency(
         user_duration=1,
@@ -23,10 +23,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=np.pi / 2,
     )
-    assert tendency.get_start_value() == approx(1)
-    assert tendency.get_end_value() == approx(1)
-    assert tendency.get_derivative_start() == approx(0)
-    assert tendency.get_derivative_end() == approx(0)
+    assert tendency.start_value == approx(1)
+    assert tendency.end_value == approx(1)
+    assert tendency.start_derivative == approx(0)
+    assert tendency.end_derivative == approx(0)
 
     tendency = SineWaveTendency(
         user_duration=1,
@@ -35,10 +35,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=np.pi,
     )
-    assert tendency.get_start_value() == approx(0)
-    assert tendency.get_end_value() == approx(0)
-    assert tendency.get_derivative_start() == approx(-2 * np.pi)
-    assert tendency.get_derivative_end() == approx(-2 * np.pi)
+    assert tendency.start_value == approx(0)
+    assert tendency.end_value == approx(0)
+    assert tendency.start_derivative == approx(-2 * np.pi)
+    assert tendency.end_derivative == approx(-2 * np.pi)
 
 
 def test_generate():
@@ -48,7 +48,7 @@ def test_generate():
     tendency = SineWaveTendency(
         user_start=0, user_duration=1, user_base=2, user_amplitude=3, user_phase=1
     )
-    time, values = tendency.generate()
+    time, values = tendency.get_value()
     assert np.all(time == np.linspace(0, 1, 101))
     assert np.allclose(values, 2 + 3 * np.sin(2 * np.pi * time + 1))
 

tests/tendencies/periodic/test_square_wave.py

@@ -10,18 +10,18 @@ def test_start_and_end():
     tendency = SquareWaveTendency(
         user_duration=1, user_base=0, user_amplitude=1, user_frequency=1
     )
-    assert tendency.get_start_value() == 1
-    assert tendency.get_end_value() == 1
-    assert tendency.get_derivative_start() == 0
-    assert tendency.get_derivative_end() == 0
+    assert tendency.start_value == 1
+    assert tendency.end_value == 1
+    assert tendency.start_derivative == 0
+    assert tendency.end_derivative == 0
 
     tendency = SquareWaveTendency(
         user_duration=1.75, user_base=0, user_amplitude=1, user_frequency=1
     )
-    assert tendency.get_start_value() == 1
-    assert tendency.get_end_value() == -1
-    assert tendency.get_derivative_start() == 0
-    assert tendency.get_derivative_end() == 0
+    assert tendency.start_value == 1
+    assert tendency.end_value == -1
+    assert tendency.start_derivative == 0
+    assert tendency.end_derivative == 0
 
     tendency = SquareWaveTendency(
         user_duration=1,
@@ -30,10 +30,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=np.pi / 2,
     )
-    assert tendency.get_start_value() == 1
-    assert tendency.get_end_value() == 1
-    assert tendency.get_derivative_start() == 0
-    assert tendency.get_derivative_end() == 0
+    assert tendency.start_value == 1
+    assert tendency.end_value == 1
+    assert tendency.start_derivative == 0
+    assert tendency.end_derivative == 0
 
     tendency = SquareWaveTendency(
         user_duration=1,
@@ -42,10 +42,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=1.5 * np.pi,
     )
-    assert tendency.get_start_value() == -1
-    assert tendency.get_end_value() == -1
-    assert tendency.get_derivative_start() == 0
-    assert tendency.get_derivative_end() == 0
+    assert tendency.start_value == -1
+    assert tendency.end_value == -1
+    assert tendency.start_derivative == 0
+    assert tendency.end_derivative == 0
 
 
 def test_generate():
@@ -60,6 +60,6 @@ def test_generate():
         user_phase=np.pi / 2,
         user_frequency=1,
     )
-    time, values = tendency.generate()
+    time, values = tendency.get_value()
     assert np.allclose(time, [0, 0.25, 0.25, 0.75, 0.75, 1.25, 1.25, 1.5])
     assert np.allclose(values, [5, 5, -1, -1, 5, 5, -1, -1])

tests/tendencies/periodic/test_triangle_wave.py

@@ -11,10 +11,10 @@ def test_start_and_end():
     tendency = TriangleWaveTendency(
         user_duration=1, user_base=0, user_amplitude=1, user_frequency=1
     )
-    assert tendency.get_start_value() == approx(0)
-    assert tendency.get_end_value() == approx(0)
-    assert tendency.get_derivative_start() == approx(4)
-    assert tendency.get_derivative_end() == approx(4)
+    assert tendency.start_value == approx(0)
+    assert tendency.end_value == approx(0)
+    assert tendency.start_derivative == approx(4)
+    assert tendency.end_derivative == approx(4)
 
     tendency = TriangleWaveTendency(
         user_duration=1,
@@ -23,10 +23,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=np.pi / 4,
     )
-    assert tendency.get_start_value() == approx(0.5)
-    assert tendency.get_end_value() == approx(0.5)
-    assert tendency.get_derivative_start() == approx(4)
-    assert tendency.get_derivative_end() == approx(4)
+    assert tendency.start_value == approx(0.5)
+    assert tendency.end_value == approx(0.5)
+    assert tendency.start_derivative == approx(4)
+    assert tendency.end_derivative == approx(4)
 
     tendency = TriangleWaveTendency(
         user_duration=1,
@@ -35,10 +35,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=np.pi,
     )
-    assert tendency.get_start_value() == approx(0)
-    assert tendency.get_end_value() == approx(0)
-    assert tendency.get_derivative_start() == approx(-4)
-    assert tendency.get_derivative_end() == approx(-4)
+    assert tendency.start_value == approx(0)
+    assert tendency.end_value == approx(0)
+    assert tendency.start_derivative == approx(-4)
+    assert tendency.end_derivative == approx(-4)
 
     tendency = TriangleWaveTendency(
         user_duration=1.5,
@@ -47,10 +47,10 @@ def test_start_and_end():
         user_frequency=1,
         user_phase=np.pi,
     )
-    assert tendency.get_start_value() == approx(0)
-    assert tendency.get_end_value() == approx(0)
-    assert tendency.get_derivative_start() == approx(-4)
-    assert tendency.get_derivative_end() == approx(4)
+    assert tendency.start_value == approx(0)
+    assert tendency.end_value == approx(0)
+    assert tendency.start_derivative == approx(-4)
+    assert tendency.end_derivative == approx(4)
 
 
 def test_generate():
@@ -65,6 +65,6 @@ def test_generate():
         user_phase=0,
         user_frequency=1,
     )
-    time, values = tendency.generate()
+    time, values = tendency.get_value()
     assert np.allclose(time, [0, 0.25, 0.75, 1.25, 1.5])
     assert np.allclose(values, [6, 9, 3, 9, 6])

tests/tendencies/test_constant.py

@@ -46,18 +46,18 @@ def test_start_and_end():
     Test the start and end values and their derivatives
     """
     tendency = ConstantTendency(user_duration=1, user_value=5)
-    assert tendency.get_start_value() == 5
-    assert tendency.get_end_value() == 5
-    assert tendency.get_derivative_start() == 0
-    assert tendency.get_derivative_end() == 0
+    assert tendency.start_value == 5
+    assert tendency.end_value == 5
+    assert tendency.start_derivative == 0
+    assert tendency.end_derivative == 0
 
 
 def test_generate():
     """
     Check the generated values.
     """
     tendency = ConstantTendency(user_start=0, user_duration=1, user_value=5)
-    time, values = tendency.generate()
+    time, values = tendency.get_value()
 
     assert np.all(time == np.array([0, 1]))
     assert np.all(values == np.array([5, 5]))

tests/tendencies/test_linear.py

@@ -133,18 +133,18 @@ def test_start_and_end():
     Test the start and end values and their derivatives
     """
     tendency = LinearTendency(user_duration=1, user_from=1, user_rate=5)
-    assert tendency.get_start_value() == 1
-    assert tendency.get_end_value() == 6
-    assert tendency.get_derivative_start() == 5
-    assert tendency.get_derivative_end() == 5
+    assert tendency.start_value == 1
+    assert tendency.end_value == 6
+    assert tendency.start_derivative == 5
+    assert tendency.end_derivative == 5
 
 
 def test_generate():
     """
     Check the generated values.
     """
     tendency = LinearTendency(user_start=0, user_duration=1, user_from=1, user_to=10)
-    time, values = tendency.generate()
+    time, values = tendency.get_value()
     assert np.all(time == np.array([0, 1]))
     assert np.all(values == np.array([1, 10]))
 

tests/tendencies/test_piecewise.py

@@ -59,10 +59,10 @@ def test_start_and_end():
     tendency = PiecewiseLinearTendency(
         user_time=np.array([1, 2, 3]), user_value=np.array([2, 4, 0])
     )
-    assert tendency.get_start_value() == 2
-    assert tendency.get_end_value() == 0
-    assert tendency.get_derivative_start() == approx(2)
-    assert tendency.get_derivative_end() == approx(-4)
+    assert tendency.start_value == 2
+    assert tendency.end_value == 0
+    assert tendency.start_derivative == approx(2)
+    assert tendency.end_derivative == approx(-4)
 
 
 def test_generate():
@@ -72,7 +72,7 @@ def test_generate():
     tendency = PiecewiseLinearTendency(
         user_time=np.array([1, 2, 3]), user_value=np.array([2, 4, 6])
     )
-    time, values = tendency.generate()
+    time, values = tendency.get_value()
     assert np.all(time == [1, 2, 3])
     assert np.all(values == [2, 4, 6])
 
@@ -84,12 +84,12 @@ def test_generate_interpolate():
     tendency = PiecewiseLinearTendency(
         user_time=np.array([1, 2, 3]), user_value=np.array([2, 4, 8])
     )
-    time, values = tendency.generate(time=[1.0, 1.5, 2.0, 2.5, 3.0])
+    time, values = tendency.get_value(time=[1.0, 1.5, 2.0, 2.5, 3.0])
     assert np.all(time == [1.0, 1.5, 2.0, 2.5, 3.0])
     assert np.allclose(values, [2.0, 3.0, 4.0, 6.0, 8.0])
 
     with pytest.raises(ValueError):
-        time, values = tendency.generate(time=[0.5, 1.5, 2.0, 2.5, 3.0])
+        time, values = tendency.get_value(time=[0.5, 1.5, 2.0, 2.5, 3.0])
 
     with pytest.raises(ValueError):
-        time, values = tendency.generate(time=[1.0, 1.5, 2.0, 2.5, 3.5])
+        time, values = tendency.get_value(time=[1.0, 1.5, 2.0, 2.5, 3.5])

tests/tendencies/test_repeat.py

@@ -63,7 +63,7 @@ def test_repeated_values(repeat_waveform):
     """Test if generated values are correct."""
     repeat_tendency = RepeatTendency(**repeat_waveform)
     times = np.linspace(0, 8, 17)
-    _, values = repeat_tendency.generate(times)
+    _, values = repeat_tendency.get_value(times)
     check_values_at_times([0, 2.5, 5, 7.5], times, values, 1)
     check_values_at_times([0.5, 3, 5.5, 8], times, values, 1.5)
     check_values_at_times([1, 3.5, 6], times, values, 2)