at.plot.synopt#

Lattice synoptics

Functions

plot_synopt(ring[, axes, dipole, ...])

Plots a synoptic of a lattice
plot_synopt(ring, axes=None, dipole={}, quadrupole={}, sextupole={}, multipole={}, monitor={}, labels=None)[source]#

Plots a synoptic of a lattice

Parameters:

  • ring (Lattice) – Lattice description.

  • axes (Axes | None) – Axes for plotting the synoptic. If None, a new figure will be created. Otherwise, a new axes object sharing the same x-axis as the given one is created.

  • labels (Type[Element] | Element | Callable[[Element], bool] | str | None | int | Sequence[int] | bool | Sequence[bool] | RefptsCode) – display the name of selected elements.

  • dipole (dict) – Dictionary of properties overloading the default properties. If None, dipoles will not be shown.

  • quadrupole (dict) – Same definition as for dipole

  • sextupole (dict) – Same definition as for dipole

  • multipole (dict) – Same definition as for dipole

  • monitor (dict) – Same definition as for dipole

Returns:

synopt_axes (Axes) – Synoptic axes

On this page