SimulationFramework.Modules.plotting package

Submodules

SimulationFramework.Modules.plotting.latticeDraw module

class latticeDraw(element_positions)

Bases: object

colorwidths = {'aperture': ('k', 0.3), 'beam_position_monitor': ((100, 100, 100), 0.2), 'cavity': ('g', 0.35), 'collimator': ('k', 0.2), 'dipole': ('b', 0.5), 'kicker': ('m', 0.25), 'line': ('k', 0.05), 'quadrupole': ('r', 0.6), 'screen': ((150, 150, 100), 0.3), 'solenoid': ('c', 0.4), 'wall_current_monitor': ((100, 100, 200), 0.2)}

defineElements()

property offset

property scale

class lineElement(start, end, color='g', width=1, scale=1)

Bases: GraphicsObject

boundingRect(self) → QRectF

generatePicture()

paint(self, painter: QPainter | None, option: QStyleOptionGraphicsItem | None, widget: QWidget | None = None)

setOffset(offset)

setScale(self, scale: float)

class rectangleElement(start, end, color='g', width=1, scale=1)

Bases: GraphicsObject

boundingRect(self) → QRectF

generatePicture()

paint(self, painter: QPainter | None, option: QStyleOptionGraphicsItem | None, widget: QWidget | None = None)

setOffset(offset)

setScale(self, scale: float)

SimulationFramework.Modules.plotting.multiAxisPlot module

main()

class mainWindow

Bases: QMainWindow

class multiAxisPlotWidget(**kwargs)

Bases: QWidget

QWidget containing pyqtgraph plot showing beam parameters

addCurve(x, y, name, label, pen)

addShadowPen(name)

colors = [<PyQt5.QtGui.QColor object>, <PyQt5.QtGui.QColor object>, <PyQt5.QtGui.QColor object>, <PyQt5.QtGui.QColor object>, <PyQt5.QtGui.QColor object>, 'r', 'k', 'm', 'g']

highlightPlot(name)

highlights a particular plot

plotParams = []

removeCurve(directory, filename=None)

finds all multiaxis curves based on a set of names, and removes them

setPenAlpha(name, alpha=255, width=3)

styles = [1, 2, 3, 4, 5]

updateMultiAxisPlot()

update main plot

updateViews()

SimulationFramework.Modules.plotting.multiPlot module

main()

class mainWindow

Bases: QMainWindow

class multiPlotWidget(xmin=None, ymin=None, xlabel=None, xlabelunits=None, setTitles=True, **kwargs)

Bases: QWidget

QWidget containing various Twiss plots

addCurve(x, y, name, label, pen)

adds a curve to the main plot

addShadowPen(name)

add/remove a shadow pen to a given plot curve

add_lattice_plot(elementlist)

clear()

clearCurves()

colors = [<PyQt5.QtGui.QColor object>, <PyQt5.QtGui.QColor object>, <PyQt5.QtGui.QColor object>, <PyQt5.QtGui.QColor object>, <PyQt5.QtGui.QColor object>, 'r', 'k', 'm', 'g']

curveClicked(name)

highlightCurveSignal

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision

highlightPlot(name)

highlights a particular plot

multiPlotLattice

[individual plotItems for each twiss plot,]}

Type:

curves - a dictionary containing {directory

multiPlotWidgets

multiPlotLattice - holds the lattice items for each Twiss plot

plotParams = []

reScaleLattice(p)

removeCurve(name)

finds all curves based on a key name, and removes them

removeData(name)

removeShadowPen(name)

add/remove a shadow pen to a given plot curve

setPenAlpha(name, alpha=255, width=3)

change the alpha channel and width of a curves pen

set_horizontal_axis_label(label=None, units=None)

styles = [1, 2, 3, 4, 5]

unHighlightCurveSignal

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision

unHighlightPlot(name)

highlights a particular plot

updateCurve(x, y, name, label)

updates a curve to the main plot

updateCurveHighlights()

SimulationFramework.Modules.plotting.plotting module

ASTRA_TW_FieldMap(fielddat, start, stop, cells, p)

add_fieldmaps_to_axes(lattice, axes, bounds=None, sections='All', fields=['cavity', 'solenoid'], include_labels=True, verbose=False)

Adds fieldmaps to an axes.

add_magnets_to_axes(lattice, axes, bounds=None, sections='All', magnets=['quadrupole', 'dipole', 'sextupole', 'beam_position_monitor', 'screen'], include_labels=True, kinetic_energy=None, verbose=False)

Adds magnets to an axes.

fieldmap_data(element)

Loads the fieldmap in absolute coordinates.

If a fieldmaps dict is given, these will be used instead of loading the file.

find_nearest(array, value)

general_plot(framework_object, ykeys=[], ykeys2=[], xkey='z', limits=None, nice=True, include_layout=False, include_labels=True, include_legend=True, include_particles=False, fields=['cavity', 'solenoid'], magnets=['quadrupole', 'dipole', 'beam_position_monitor', 'screen', 'wall_current_monitor', 'aperture'], grid=False, **kwargs)

getattrsplit(self, attr)

load_elements(lattice, bounds=None, sections='All', types=['cavity', 'solenoid'], kinetic_energy=None, verbose=False, scale=1)

class magnet_plotting_data(kinetic_energy=None)

Bases: object

aperture(e)

beam_position_monitor(e)

dipole(e)

full_rectangle(e, half_height, width=0)

half_rectangle(e, half_height)

quadrupole(e)

screen(e)

sextupole(e)

wall_current_monitor(e)

plot(framework_object, ykeys=['sigma_x', 'sigma_y'], ykeys2=['sigma_z'], xkey='z', limits=None, nice=True, include_layout=False, include_labels=True, include_legend=True, include_particles=False, fields=['cavity', 'solenoid'], magnets=['quadrupole', 'dipole', 'beam_position_monitor', 'screen', 'wall_current_monitor', 'aperture'], grid=False, **kwargs)

Plots stat output multiple keys.

If a list of ykeys2 is given, these will be put on the right hand axis. This can also be given as a single key.

Logical switches, all default to True:

nice: a nice SI prefix and scaling will be used to make the numbers reasonably sized.

include_legend: The plot will include the legend

include_layout: the layout plot will be displayed at the bottom

include_labels: the layout will include element labels.

Copied almost verbatim from lume-impact’s Impact.plot.plot_stats_with_layout

plot_fieldmaps(lattice, sections='All', include_labels=True, limits=None, figsize=(12, 4), fields=['cavity', 'solenoid'], magnets=['quadrupole', 'dipole', 'beam_position_monitor', 'screen'], **kwargs)

Simple fieldmap plot

trans(M)

Module contents