MATRIX_Lattice#

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

Bases: orbit.lattice.AccLattice.AccLattice

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

Methods Summary

`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
`initialize`()	Method.
`makeMatrix`(pos)	Calculates the one turn matrix.
`makeOneTurnMatrix`()	Calculates the one turn matrix.
`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),...] ).

Methods Documentation

getOneTurnMatrix()[source]#: Returns the one turn matrix.

getRingDispersionDataX(momentum, mass)[source]#: Returns the tuple ([(position, dispX),…],[(position,disp_pX),…] ).

getRingDispersionDataY(momentum, mass)[source]#: Returns the tuple ([(position, dispY),…],[(position,disp_pY),…] ).

getRingOrbit(z0)[source]#: Returns the tuple ([(position, x] ).

getRingParametersDict(momentum, mass)[source]#: Returns the dictionary with different ring parametrs calculated from the one turn transport matrix.

getRingTwissDataX(momentum, mass)[source]#: Returns the tuple ([(position, phase advanceX)/2/pi,…],[(position, alphaX),…],[(position,betaX),…] ).

getRingTwissDataY(momentum, mass)[source]#: Returns the tuple ([(position, phase advanceY/2/pi),…],[(position, alphaY),…],[(position,betaY),…] ).

getSubLattice(index_start=- 1, index_stop=- 1)[source]#: It returns the new MATRIX_Lattice with children with indexes between index_start and index_stop inclusive

initialize()[source]#: Method. Initializes the matrix lattice, child node structures, and calculates the one turn matrix.

makeMatrix(pos)[source]#: Calculates the one turn matrix.

makeOneTurnMatrix()[source]#: Calculates the one turn matrix.

trackBunch(bunch, paramsDict={}, actionContainer=None)[source]#: It tracks the bunch through the lattice.

trackDispersionData(momentum, mass, disp, disp_p, direction='x')[source]#: Returns the tuple ([(position, disp),…],[(position,disp_p),…] ). The tracking starts from the values specified as the initial parameters. The possible values for direction parameter “x” or “y”.

trackOrbit(z0)[source]#: Returns the tuple ([(position, x),…], [(position, y),…] ). The tracking starts from the values specified as the initial parameters. z0 fulfill: z0 = Mz0 with M as one turn matrix

trackTwissData(alpha, beta, direction='x')[source]#: Returns the tuple ([(position, phase advance/2/pi),…], [(position, alpha),…],[(position,beta),…] ). The tracking starts from the values specified as the initial parameters. The possible values for direction parameter “x” or “y”.