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, **kwargs)[source]#

Plots a synoptic of a lattice.

Parameters:
  • ring (Lattice) – Lattice description.

  • axes (Axes) – 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 (Refpts) – Select the elements for which the name is displayed. Default: None,

  • dipole (dict) – Dictionary of properties overloading the default properties of the dipole representation. Example: {"facecolor": "xkcd:electric blue"}. If None, dipoles are not 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