add missing plot_dipole_k1 parameter to plot_latwiss, transmitter to …

…layout plotting utility
fsoubelet · Oct 19, 2021 · ccf0f19 · ccf0f19
1 parent 2fee91f
commit ccf0f19
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/pyhdtoolkit/cpymadtools/plotters.py b/pyhdtoolkit/cpymadtools/plotters.py
@@ -577,6 +577,7 @@ def plot_latwiss(
         xoffset: float = 0,
         xlimits: Tuple[float, float] = None,
         plot_dipoles: bool = True,
+        plot_dipole_k1: bool = False,
         plot_quadrupoles: bool = True,
         plot_bpms: bool = False,
         disp_ylim: Tuple[float, float] = (-10, 125),
@@ -603,6 +604,8 @@ def plot_latwiss(
                 not None, using the tuple passed.
             plot_dipoles (bool): if True, dipole patches will be plotted on the layout subplot of
                 the figure. Defaults to True. Dipoles are plotted in blue.
+            plot_dipole_k1 (bool): if `True`, dipole elements with a quadrupolar gradient will have this
+                gradient plotted as a quadrupole patch. Defaults to `False`.
             plot_quadrupoles (bool): if True, quadrupole patches will be plotted on the layout
                 subplot of the figure. Defaults to True. Quadrupoles are plotted in red.
             plot_bpms (bool): if True, additional patches will be plotted on the layout subplot to represent
@@ -653,6 +656,7 @@ def plot_latwiss(
             xoffset=xoffset,
             xlimits=xlimits,
             plot_dipoles=plot_dipoles,
+            plot_dipole_k1=plot_dipole_k1,
             plot_quadrupoles=plot_quadrupoles,
             plot_bpms=plot_bpms,
             k0l_lim=k0l_lim,
@@ -1149,8 +1153,8 @@ def _plot_machine_layout(
             not None, using the tuple passed.
         plot_dipoles (bool): if True, dipole patches will be plotted on the layout subplot of
             the figure. Defaults to True. Dipoles are plotted in blue.
-        plot_dipole_k1 (bool): if True, dipole elements with a quadrupolar gradient will have this
-            gradient plotted as a quadrupole patch. Defaults to False.
+        plot_dipole_k1 (bool): if `True`, dipole elements with a quadrupolar gradient will have this
+            gradient plotted as a quadrupole patch. Defaults to `False`.
         plot_quadrupoles (bool): if True, quadrupole patches will be plotted on the layout
             subplot of the figure. Defaults to True. Quadrupoles are plotted in red.
         plot_bpms (bool): if True, additional patches will be plotted on the layout subplot to represent