ZgoubidooPlotlyArtist

class zgoubidoo.vis.ZgoubidooPlotlyArtist(config: Optional[Mapping] = None, layout: Optional[Mapping] = None, width: Optional[float] = None, height: Optional[float] = None, **kwargs)[source]

Bases: georges_core.vis.plotly.PlotlyArtist

TODO

Parameters
  • config –

  • layout –

  • width –

  • height –

  • **kwargs –

Methods Summary

plot_beamline(beamline[, start, stop, …])

Use a ZgoubiPlot artist to perform the rendering of the beamline with elements and tracks.

plot_cartouche(beamline[, vertical_position])

param beamline

plot_twiss(beamline, twiss, twiss_madx[, …])

param beamline

Methods Documentation

plot_beamline(beamline: _Input, start: Optional[Union[str, _Command]] = None, stop: Optional[Union[str, _Command]] = None, with_drifts: bool = False, with_magnet_poles: bool = True, with_apertures: bool = True, with_frames: bool = False, points_in_polar_paths: int = 20, opacity: float = 0.5, reference_frame: str = 'entry_patched') → None[source]

Use a ZgoubiPlot artist to perform the rendering of the beamline with elements and tracks.

The Input must be surveyed first so that all the placements are taken into account for the plotting.

Parameters
  • beamline –

  • start –

  • stop –

  • with_drifts –

  • with_magnet_poles –

  • with_apertures –

  • with_frames –

  • points_in_polar_paths –

  • opacity –

  • reference_frame –

plot_cartouche(beamline: _Input, vertical_position: float = 1.2)[source]
Parameters
  • beamline –

  • vertical_position –

Returns:

classmethod plot_twiss(beamline, twiss: pandas.core.frame.DataFrame, twiss_madx: Optional[pandas.core.frame.DataFrame], beta: bool = True, dispersion: bool = True, dispersion_prime: bool = False, alpha: bool = False, mu: bool = False)[source]
Parameters
  • beamline –

  • twiss –

  • twiss_madx –

  • beta –

  • dispersion –

  • dispersion_prime –

  • alpha –

  • mu –

Returns: