simba.Modules.plotting package

Submodules

simba.Modules.plotting.latticeDraw module

simba.Modules.plotting.multiAxisPlot module

simba.Modules.plotting.multiPlot module

simba.Modules.plotting.plotting module

ASTRA_TW_FieldMap(fielddat, start, stop, cells, p)[source]
add_fieldmaps_to_axes(lattice, axes, bounds=None, sections='All', fields=['RFCavity', 'Solenoid'], include_labels=True, verbose=False)[source]

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)[source]

Adds magnets to an axes.

fieldmap_data(element, master_lattice)[source]

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)[source]
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=['RFCavity', 'Solenoid'], magnets=['quadrupole', 'dipole', 'beam_position_monitor', 'screen', 'wall_current_monitor', 'aperture'], grid=False, **kwargs)[source]
getattrsplit(self, attr)[source]
load_elements(lattice, bounds=None, sections='All', types=['RFCavity', 'Solenoid'], kinetic_energy=None, verbose=False, scale=1)[source]
class magnet_plotting_data(kinetic_energy=None)[source]

Bases: object

aperture(e)[source]
beam_position_monitor(e)[source]
dipole(e)[source]
full_rectangle(e, half_height, width=0)[source]
half_rectangle(e, half_height)[source]
quadrupole(e)[source]
screen(e)[source]
sextupole(e)[source]
wall_current_monitor(e)[source]
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=['RFCavity', 'Solenoid'], magnets=['quadrupole', 'dipole', 'beam_position_monitor', 'screen', 'wall_current_monitor', 'aperture'], grid=False, ax_top=None, ax_field_layout=None, ax_magnet_layout=None, **kwargs)[source]
plot_fieldmaps(lattice, sections='All', include_labels=True, limits=None, figsize=(12, 4), fields=['RFCavity', 'Solenoid'], magnets=['quadrupole', 'dipole', 'beam_position_monitor', 'screen'], **kwargs)[source]

Simple fieldmap plot

trans(M)[source]

Module contents