Ctrl+K

display_gradients

display_gradients#

mrinufft.trajectories.display.display_gradients(trajectory, shot_ids=(0,), figsize=5, fill_area=True, show_signal=True, uni_signal='gray', uni_gradient=None, subfigure=None, show_constraints=False, gmax=0.04, smax=0.1, constraints_order=None, raster_time=0.01, **constraints_kwargs)[source]#

Display gradients based on trajectory of any dimension.

Parameters:

  • trajectory (array_like) – Trajectory to display.

  • shot_ids (list of int) – Indices of the shots to display. The default is (0,).

  • figsize (float, optional) – Size of the figure.

  • fill_area (bool, optional) – Fills the area under the curve for improved visibility and representation of the integral, aka trajectory. The default is True.

  • show_signal (bool, optional) – Show an additional illustration of the signal as the modulated distance to the center. The default is True.

  • uni_signal (str or None, optional) – Define whether the signal should be represented by a unique color given as argument or just by the default color cycle when None. The default is “gray”.

  • uni_signal – Define whether the gradients should be represented by a unique color given as argument or just by the default color cycle when None. The default is None.

  • subfigure (plt.Figure or plt.SubFigure, optional) – The figure where the trajectory should be displayed. The default is None.

  • show_constraints (bool, optional) – Display the points where the gradients and slew rates are above the gmax and smax limits, respectively. The default is False.

  • gmax (float, optional) – Maximum constraint on the gradients in T/m. The default is DEFAULT_GMAX.

  • smax (float, optional) – Maximum constraint on the slew rates in T/m/ms. The default is DEFAULT_SMAX.

  • constraint_order (int, str, optional) – Norm order defining how the constraints are checked, typically 2 or np.inf, following the numpy.linalg.norm conventions on parameter ord. The default is None.

  • raster_time (float, optional) – Amount of time between the acquisition of two consecutive samples in ms. The default is DEFAULT_RASTER_TIME.

  • **kwargs – Acquisition parameters used to check on hardware constraints, following the parameter convention from mrinufft.trajectories.utils.compute_gradients_and_slew_rates.

Returns:

axes – Axes of the figure.

Return type:

plt.Axes

Contents