MAINT: propagate -> drift

ChristopherMayes · Aug 20, 2024 · b8f822b · b8f822b
1 parent 93658ca
commit b8f822b
Show file tree

Hide file tree

Showing 3 changed files with 92 additions and 30 deletions.
diff --git a/docs/examples/wavefront.ipynb b/docs/examples/wavefront.ipynb
diff --git a/pmd_beamphysics/wavefront.py b/pmd_beamphysics/wavefront.py
@@ -888,15 +888,15 @@ def focus(
         self._field_kspace = None
         return self
 
-    def propagate(
+    def drift(
         self,
         direction: Union[str, int],
         distance: float,
         *,
         inplace: bool = False,
     ) -> Wavefront:
         """
-        Propagate this Wavefront in-place along Z in meters.
+        Drift this Wavefront along `direction` in meters.
 
         Parameters
         ----------
@@ -918,7 +918,7 @@ def propagate(
 
         if not inplace:
             wavefront = copy.copy(self)
-            return wavefront.propagate(direction, distance, inplace=True)
+            return wavefront.drift(direction, distance, inplace=True)
 
         self._field_kspace = drift_propagator_z(
             field_kspace=self.field_kspace,

diff --git a/tests/test_wavefront.py b/tests/test_wavefront.py
@@ -39,15 +39,15 @@ def projection_plane(request: pytest.FixtureRequest) -> str:
     return request.param
 
 
-def test_smoke_propagate_z_in_place(wavefront: Wavefront) -> None:
+def test_smoke_drift_z_in_place(wavefront: Wavefront) -> None:
     # Implicitly calculates the FFT:
-    wavefront.propagate(direction="z", distance=0.0, inplace=True)
+    wavefront.drift(direction="z", distance=0.0, inplace=True)
     # Use the property to calculate the inverse fft:
     wavefront.field_rspace
 
 
-def test_smoke_propagate_z(wavefront: Wavefront) -> None:
-    new = wavefront.propagate(direction="z", distance=0.0, inplace=False)
+def test_smoke_drift_z(wavefront: Wavefront) -> None:
+    new = wavefront.drift(direction="z", distance=0.0, inplace=False)
     assert new is not wavefront