orbit.matrix_lattice.MATRIX_Lattice#

class orbit.matrix_lattice.MATRIX_Lattice(name=None)[source]#

The subclass of the AccLattice class. Shell class for the BaseMATRIX nodes collection. In the beginning the lattcie is empty.

__init__(name=None)[source]#: Constructor. Creates an empty accelerator lattice.

Methods

`__init__`([name])	Constructor.
`addNode`(node[, index])	Method.
`getLength`()	Method.
`getName`()	Method.
`getNodeForName`(name)	Method.
`getNodeIndex`(node)	Method.
`getNodePositionsDict`()	Method.
`getNodes`()	Method.
`getNodesForName`(name)	Method.
`getNodesForSubstring`(sub[, no_sub])	Method.
`getNodesOfClass`(class_of_node)	Method.
`getOneTurnMatrix`()	Returns the one turn matrix.
`getRingDispersionDataX`(momentum, mass)	Returns the tuple ([(position, dispX),...],[(position,disp_pX),...] ).
`getRingDispersionDataY`(momentum, mass)	Returns the tuple ([(position, dispY),...],[(position,disp_pY),...] ).
`getRingOrbit`(z0)	Returns the tuple ([(position, x] ).
`getRingParametersDict`(momentum, mass)	Returns the dictionary with different ring parametrs calculated from the one turn transport matrix.
`getRingTwissDataX`(momentum, mass)	Returns the tuple ([(position, phase advanceX)/2/pi,...],[(position, alphaX),...],[(position,betaX),...] ).
`getRingTwissDataY`(momentum, mass)	Returns the tuple ([(position, phase advanceY/2/pi),...],[(position, alphaY),...],[(position,betaY),...] ).
`getSubLattice`([index_start, index_stop])	It returns the new MATRIX_Lattice with children with indexes between index_start and index_stop inclusive
`getType`()	Method.
`initialize`()	Method.
`isInitialized`()	Method.
`makeMatrix`(pos)	Calculates the one turn matrix.
`makeOneTurnMatrix`()	Calculates the one turn matrix.
`reverseOrder`()	This method is used for a lattice reversal and a bunch backtracking.
`setName`([name])	Method.
`setNodes`(childrenNodes)	Method.
`setType`([type_in])	Method.
`structureToText`()	Returns the text with the lattice structure.
`trackActions`(actionsContainer[, paramsDict, ...])	Method.
`trackBunch`(bunch[, paramsDict, actionContainer])	It tracks the bunch through the lattice.
`trackDispersionData`(momentum, mass, disp, disp_p)	Returns the tuple ([(position, disp),...],[(position,disp_p),...] ).
`trackOrbit`(z0)	Returns the tuple ([(position, x),...], [(position, y),...] ).
`trackTwissData`(alpha, beta[, direction])	Returns the tuple ([(position, phase advance/2/pi),...], [(position, alpha),...],[(position,beta),...] ).

Attributes

`AFTER`
`BEFORE`
`BODY`
`ENTRANCE`
`EXIT`