orbit.py_linac.lattice

Functions

GetGlobalQuadGradient(accLattice, z)	The service function for the overlapping fields package.
GetGlobalQuadGradientDerivative(accLattice, z)	The service function for the overlapping fields package.
GetGlobalRF_AxisField(accLattice, z)	The service function for the overlapping RF fields package.
getAllMagnetsInLattice(accLattice)	Returns the array with all magnets including magnets on all levels (e.g correctors)
getAllNodesInLattice(accLattice)	Returns the array with all nodes on all levels (even sub-child).
getNodeForNameFromWholeLattice(accLattice, name)	Returns the accelerator node or an array of nodes with the same name.
getNodePosDictForWholeLattice(accLattice)	Returns the dict[node] = (posStart,posEnd) for all nodes (not only for the firts level).

Classes

AbstractRF_Gap([name])	This is an abstarct class for all RF Gap classes.
AxisFieldRF_Gap(baserf_gap)	The RF gap representation that uses the RF axis field.
AxisField_and_Quad_RF_Gap(axis_field_rf_gap)	The class represents the part of the RF gap.
BaseLinacNode([name])	The base abstract class of the linac accelerator elements hierarchy.
BaseRF_Gap([name])	The simplest RF gap representation.
Bend([name])	Bend Combined Functions TEAPOT element.
CircleLinacApertureNode(radius[, pos, c, d, ...])	The curcular aperture shape = 1
DCorrectorH([name])	The Horizontal Dipole Corrector.
DCorrectorV([name])	The Vertical Dipole Corrector.
Drift([name])	Drift element.
EllipseLinacApertureNode(a, b[, pos, c, d, name])	The ellipse aperture shape = 2
LinacAccLattice([name])	The subclass of the AccLattice class.
LinacApertureNode(shape, a, b[, pos, c, d, name])	The aperture classes removes particles from bunch and places them in the lostbunch if their coordinates are not inside the aperture: The shape variable could be: 1 is circle (a is a radius) 2 is elipse (a and b are a half-axises) 3 is rectangle (a and b are a half-horizontal and vertical sizes) c and d parameters are x and y offsets of the center
LinacBPM([frequency, name])	The linac BPM representation.
LinacEnergyApertureNode([name])	The phase aperture classes removes particles from bunch and places them in the lostbunch if their phases are not inside the min-max energy.
LinacMagnetNode([name])	The abstract class of the linac magnet.
LinacNode([name])	The abstract class of the linac accelerator elements hierarchy that can be tilted.
LinacPhaseApertureNode([frequency, name])	The phase aperture classes removes particles from bunch and places them in the lostbunch if their phases are not inside the min-max phases.
LinacTrMatricesController()	LinacTrMatricesController keeps the references to the LinacTrMatrixGenNode instances.
LinacTrMatrixGenNode(trMatricesController[, ...])	Linac Accelerator Nodes for Transport Matrices generation.
MarkerLinacNode([name])	This is a marker.
OverlappingQuadsNode([name])	The class represent the set of quads with the overlapping fields.
Quad([name])	Quad Combined Function TEAPOT element.
RF_AxisFieldsStore()	The dictionary with the axis field Functions with the input file names as keys.
RF_Cavity([name])	This is the class to keep refernces to the RF Gaps which are BaseLinacNode subclasses.
RectangleLinacApertureNode(a, b[, pos, c, ...])	The rectangle aperture shape = 3
Sequence([name])	This is the class to keep refernces to AccNodes that constitute the accelerator sequence.
Solenoid([name])	Solenoid TEAPOT based element.
ThickKick([name])	Thick kiker linac node.

Modules

orbit.py_linac.lattice.LinacAccLatticeFunc	This package is a collection of the lattice functions.
orbit.py_linac.lattice.LinacAccLatticeLib	The general Linac Accelerator lattice.
orbit.py_linac.lattice.LinacAccNodes	This module is a collection of the linac accelerator nodes which are the subclasses of the AccNode class.
orbit.py_linac.lattice.LinacApertureNodes
orbit.py_linac.lattice.LinacDiagnosticsNodes	This package is a collection of diagnostics nodes fo linacs.
orbit.py_linac.lattice.LinacFieldOverlappingNodes
orbit.py_linac.lattice.LinacRfGapNodes	This package is a collection of the RF gap node implementations.
orbit.py_linac.lattice.LinacTransportMatrixGenNodes