WaveformGenerator: Rename 'load_equation' to 'load_function'

Author: bessman

pslab/instrument/analog.py

@@ -207,7 +207,7 @@ class AnalogOutput:
     wavetype : {'sine', 'tria', 'custom'}
         Type of waveform on this pin. 'sine' is a sine wave with amplitude
         3.3 V, 'tria' is a triangle wave with amplitude 3.3 V, 'custom' is any
-        other waveform set with :meth:`load_equation` or :meth:`load_table`.
+        other waveform set with :meth:`load_function` or :meth:`load_table`.
     """
 
     RANGE = (-3.3, 3.3)

pslab/instrument/waveform_generator.py

@@ -103,11 +103,11 @@ class WaveformGenerator:
     Reduce the amplitude on SI1:
 
     >>> import numpy as np
-    >>> wavegen.load_equation("SI1", lambda x: 1.5*np.sin(x), [0, 2*np.pi])
+    >>> wavegen.load_function("SI1", lambda x: 1.5*np.sin(x), [0, 2*np.pi])
 
     Output two superimposed sine waves on SI2:
 
-    >>> wavegen.load_equation("SI2", lambda x: 2*np.sin(x) + np.sin(5*x), [0, 2*np.pi])
+    >>> wavegen.load_function("SI2", lambda x: 2*np.sin(x) + np.sin(5*x), [0, 2*np.pi])
     """
 
     _HIGHRES_TABLE_SIZE = 512
@@ -232,10 +232,10 @@ def _get_table_size(self, frequency: float) -> int:
 
         return table_size
 
-    def load_equation(
+    def load_function(
         self, channel: str, function: Union[str, Callable], span: List[float] = None
     ):
-        """Load a custom waveform equation.
+        """Load a custom waveform function.
 
         Parameters
         ----------
@@ -251,7 +251,8 @@ def load_equation(
             for a sine wave or triangle wave with amplitude 3.3 V.
         span : List[float], optional
             The minimum and maximum x values between which to evaluate
-            'function'. Omit if 'function' is 'sine' or 'tria'.
+            'function'. Should typically correspond to one period. Omit if
+            'function' is 'sine' or 'tria'.
         """
         if function == "sine":
 

tests/test_cli.py

@@ -188,7 +188,7 @@ def test_collect_json_file(collect, tmp_path):
 
 def test_wave_load_table(wave, mocker):
     wavegen = WaveformGenerator(mocker.Mock())
-    wavegen.load_equation("SI1", "tria")
+    wavegen.load_function("SI1", "tria")
 
     def tria(x):
         return AnalogOutput.RANGE[1] * (abs(x % 4 - 2) - 1)
@@ -210,7 +210,7 @@ def test_wave_load_table_expand(wave):
 
 def test_wave_load_tablefile(wave, mocker, tmp_path):
     wavegen = WaveformGenerator(mocker.Mock())
-    wavegen.load_equation("SI1", "tria")
+    wavegen.load_function("SI1", "tria")
 
     def tria(x):
         return AnalogOutput.RANGE[1] * (abs(x % 4 - 2) - 1)

tests/test_waveform_generator.py

@@ -59,7 +59,7 @@ def scope(handler: SerialHandler) -> Oscilloscope:
 
 def test_sine_wave(wave: WaveformGenerator, scope: Oscilloscope):
     frequency = 500
-    wave.load_equation("SI1", "sine")
+    wave.load_function("SI1", "sine")
     wave.generate("SI1", frequency)
     time.sleep(0.1)
     x, y = scope.capture(1, 10000, 1, trigger=0)
@@ -85,7 +85,7 @@ def expected_f(x, amplitude, frequency, phase):
 
 def test_triangle_wave(wave: WaveformGenerator, scope: Oscilloscope):
     frequency = 2000
-    wave.load_equation("SI1", "tria")
+    wave.load_function("SI1", "tria")
     wave.generate("SI1", frequency)
     time.sleep(0.1)
     x, y = scope.capture(1, 10000, 1, trigger=0)
@@ -119,7 +119,7 @@ def test_superposition(wave: WaveformGenerator, scope: Oscilloscope):
     def super_sine(x):
         return amplitude1 * np.sin(x) + amplitude2 * np.sin(5 * x)
 
-    wave.load_equation("SI1", super_sine, [0, 2 * np.pi])
+    wave.load_function("SI1", super_sine, [0, 2 * np.pi])
     wave.generate("SI1", frequency)
     time.sleep(0.1)
     x, y = scope.capture(1, 10000, 1, trigger=0)
@@ -153,8 +153,8 @@ def expected_f(x, amplitude1, amplitude2, frequency, phase):
 def test_sine_phase(wave: WaveformGenerator, scope: Oscilloscope):
     frequency = 500
     phase = 90
-    wave.load_equation("SI1", "sine")
-    wave.load_equation("SI2", "sine")
+    wave.load_function("SI1", "sine")
+    wave.load_function("SI2", "sine")
     wave.generate(["SI1", "SI2"], frequency, phase)
     time.sleep(0.1)
     x, y1, y2 = scope.capture(2, 5000, 2, trigger=0)