[docs] update the docnames

Author: chaithyagr

src/mrinufft/io/nsp.py

@@ -20,7 +20,7 @@
     unnormalize_trajectory,
     convert_trajectory_to_gradients,
 )
-from mrinufft.trajectories.tools import get_gradients_for_set_time
+from mrinufft.trajectories.tools import get_gradient_amplitudes_to_travel_for_set_time
 
 from .siemens import read_siemens_rawdat
 
@@ -290,7 +290,7 @@ def write_trajectory(
                 "pregrad is only supported for version >= 5.1, "
                 "please set version to 5.1 or higher."
             )
-        start_gradients = get_gradients_for_set_time(
+        start_gradients = get_gradient_amplitudes_to_travel_for_set_time(
             ke=initial_positions,
             ge=gradients[:, 0],
             **scan_consts,
@@ -308,7 +308,7 @@ def write_trajectory(
         if postgrad == "slowdown_to_edge":
             # Always end at KMax, the spoilers can be handeled by the sequence.
             edge_locations[..., 0] = img_size[0] / FOV[0] / 2
-        end_gradients = get_gradients_for_set_time(
+        end_gradients = get_gradient_amplitudes_to_travel_for_set_time(
             ke=edge_locations,
             gs=gradients[:, -1],
             ks=final_positions,

src/mrinufft/trajectories/tools.py

@@ -378,7 +378,7 @@ def unepify(trajectory: NDArray, Ns_readouts: int, Ns_transitions: int) -> NDArr
     return trajectory
 
 
-def get_gradient_timing_values(
+def get_gradient_times_to_travel(
     ks: NDArray | None = None,
     ke: NDArray | None = None,
     gs: NDArray | None = None,
@@ -400,13 +400,13 @@ def get_gradient_timing_values(
     Parameters
     ----------
     ks : NDArray
-        Starting k-space positions, shape (num_shots, dimension).
+        Starting k-space positions, shape (nb_shots, nb_dimension).
     ke : NDArray, default None when it is 0
-        Ending k-space positions, shape (num_shots, dimension).
+        Ending k-space positions, shape (nb_shots, nb_dimension).
     gs : NDArray, default None when it is 0
-        Starting gradient values, shape (num_shots, dimension).
+        Starting gradient values, shape (nb_shots, nb_dimension).
     ge : NDArray, default None when it is 0
-        Ending gradient values, shape (num_shots, dimension).
+        Ending gradient values, shape (nb_shots, nb_dimension).
     gamma : float, optional
         Gyromagnetic ratio in Hz/T. Default is Gammas.Hydrogen.
     raster_time : float, optional
@@ -471,7 +471,7 @@ def get_gradient_timing_values(
     return n_ramp_down, n_ramp_up, n_plateau, gi
 
 
-def get_gradients_for_set_time(
+def get_gradient_amplitudes_to_travel_for_set_time(
     ke: NDArray,
     ks: NDArray | None = None,
     gs: NDArray | None = None,
@@ -495,13 +495,13 @@ def get_gradients_for_set_time(
     Parameters
     ----------
     ke : NDArray
-        Ending k-space positions, shape (num_shots, dimension).
+        Ending k-space positions, shape (nb_shots, nb_dimension).
     ks : NDArray, default None when it is 0
-        Starting k-space positions, shape (num_shots, dimension).
+        Starting k-space positions, shape (nb_shots, nb_dimension).
     gs : NDArray, default None when it is 0
-        Starting gradient values, shape (num_shots, dimension).
+        Starting gradient values, shape (nb_shots, nb_dimension).
     ge : NDArray, default None when it is 0
-        Ending gradient values, shape (num_shots, dimension).
+        Ending gradient values, shape (nb_shots, nb_dimension).
     N : int, default None
         Number of time steps (samples) for the gradient waveform.
         If None, timing is calculated based on the area needed and hardware limits.
@@ -517,8 +517,9 @@ def get_gradients_for_set_time(
     Returns
     -------
     G : NDArray
-        Gradient waveforms, shape (num_shots, N, dimension), where each entry contains
-        the gradient value at each time step for each shot and dimension.
+        Gradient waveforms, shape (nb_shots, nb_samples_per_shot, nb_dimension)
+        , where each entry contains the gradient value at each time step
+         for each shot and dimension.
 
     Notes
     -----
@@ -540,10 +541,10 @@ def get_gradients_for_set_time(
 
     assert (
         ks.shape == ke.shape == gs.shape == ge.shape
-    ), "All input arrays must have shape (num_shots, dimension)"
+    ), "All input arrays must have shape (nb_shots, nb_dimension)"
     if N is None:
         # Calculate the number of time steps based on the area needed
-        n_ramp_down, n_ramp_up, n_plateau, gi = get_gradient_timing_values(
+        n_ramp_down, n_ramp_up, n_plateau, gi = get_gradient_times_to_travel(
             ks=ks,
             ke=ke,
             ge=ge,
@@ -591,10 +592,10 @@ def get_gradients_for_set_time(
     gi = (2 * area_needed - (n_ramp_down + 1) * gs - (n_ramp_up - 1) * ge) / (
         n_ramp_down + n_ramp_up + 2 * n_plateau
     )
-    num_shots, dimension = ke.shape
-    G = np.zeros((num_shots, N, dimension), dtype=np.float32)
-    for i in range(num_shots):
-        for d in range(dimension):
+    nb_shots, nb_dimension = ke.shape
+    G = np.zeros((nb_shots, N, nb_dimension), dtype=np.float32)
+    for i in range(nb_shots):
+        for d in range(nb_dimension):
             start = 0
             G[i, : n_ramp_down[i, d], d] = np.linspace(
                 gs[i, d], gi[i, d], n_ramp_down[i, d], endpoint=False

tests/test_io.py

@@ -10,7 +10,7 @@
     DEFAULT_SMAX,
     DEFAULT_RASTER_TIME,
 )
-from mrinufft.trajectories.tools import get_gradients_for_set_time
+from mrinufft.trajectories.tools import get_gradient_amplitudes_to_travel_for_set_time
 from mrinufft.trajectories.trajectory3D import initialize_3D_cones
 from pytest_cases import parametrize, parametrize_with_cases
 from case_trajectories import CasesTrajectories
@@ -62,7 +62,7 @@ def test_trajectory_state_changer(kspace_loc, shape, gamma, raster_time, gmax, s
     resolution = dimension * (0.23 / 256,)
     trajectory = kspace_loc / resolution
     gradients = np.diff(trajectory, axis=1) / gamma / raster_time
-    GS = get_gradients_for_set_time(
+    GS = get_gradient_amplitudes_to_travel_for_set_time(
         ke=trajectory[:, 0],
         ge=gradients[:, 0],
         gamma=gamma,
@@ -83,7 +83,7 @@ def test_trajectory_state_changer(kspace_loc, shape, gamma, raster_time, gmax, s
     # Check that gradients match.
     np.testing.assert_allclose(GS[:, 0], 0, atol=1e-5)
 
-    GE = get_gradients_for_set_time(
+    GE = get_gradient_amplitudes_to_travel_for_set_time(
         ks=trajectory[:, -1],
         ke=np.zeros_like(trajectory[:, -1]),
         gs=gradients[:, -1],