TEAPOT_MATRIX_Lattice#

class orbit.teapot.TEAPOT_MATRIX_Lattice(teapot_lattice, bunch, name=None)[source]#

Bases: orbit.matrix_lattice.MATRIX_Lattice.MATRIX_Lattice

The subclass of the MATRIX_Lattice class. Shell class for the BaseMATRIX nodes collection. The TEAPOT_Lattice instance is needed to create the TEAPOT_MATRIX_Lattice instance. The nodes for RF elements are the usual TEAPOT RingRFTEAPOT nodes. The Bunch instance is needed for the MATRIX_Lattice constructor to specify the particle’s energy and other parameters.

Methods Summary

`getChromaticitiesXY`()	Calculates chromaticities for X,Y planes for the whole ring
`getKinEnergy`()
`getRingDispersionDataX`()	Returns the tuple ([(position, dispX),...],[(position,disp_pX),...] ).
`getRingDispersionDataY`()	Returns the tuple ([(position, dispY),...],[(position,disp_pY),...] ).
`getRingMatrix`()	Returns the dictionary with different ring parametrs calculated from the one turn transport matrix.
`getRingOrbit`(z0)	Returns the tuple ([(position, X),...],[(position,Y),...] ).
`getRingParametersDict`()	Returns the dictionary with different ring parametrs calculated from the one turn transport matrix.
`getRingTwissDataX`()	Returns the tuple (tuneX, [(position, alphaX),...],[(position,betaX),...] ).
`getRingTwissDataY`()	Returns the tuple (tuneY, [(position, alphaY),...],[(position,betaY),...] ).
`getTransferDispersionDataX`(disp, disp_p)	Returns the tuple ([(position, dispX),...],[(position,disp_pX),...] ).
`getTransferDispersionDataY`(disp, disp_p)	Returns the tuple ([(position, dispY),...],[(position,disp_pY),...] ).
`getTransferTwissDataX`(alpha_x, beta_x)	Returns the tuple (tuneX, [(position, alphaX),...],[(position,betaX),...] ).
`getTransferTwissDataY`(alpha_y, beta_y)	Returns the tuple (tuneY, [(position, alphaY),...],[(position,betaY),...] ).
`rebuild`([Ekin])

Methods Documentation

getChromaticitiesXY()[source]#: Calculates chromaticities for X,Y planes for the whole ring

getKinEnergy()[source]#

getRingDispersionDataX()[source]#: Returns the tuple ([(position, dispX),…],[(position,disp_pX),…] ). It overloads the getRingDispersionDataX(p,m) method from the parent MATRIX_Lattice class.

getRingDispersionDataY()[source]#: Returns the tuple ([(position, dispY),…],[(position,disp_pY),…] ). It overloads the getRingDispersionDataY(p,m) method from the parent MATRIX_Lattice class.

getRingMatrix()[source]#: Returns the dictionary with different ring parametrs calculated from the one turn transport matrix. It overloads the getRingParametersDict(p,m) method from the parent MATRIX_Lattice class.

getRingOrbit(z0)[source]#: Returns the tuple ([(position, X),…],[(position,Y),…] ). It overloads the getRingTwissDataX(p,m) method from the parent MATRIX_Lattice class.

getRingParametersDict()[source]#: Returns the dictionary with different ring parametrs calculated from the one turn transport matrix. It overloads the getRingParametersDict(p,m) method from the parent MATRIX_Lattice class.

getRingTwissDataX()[source]#: Returns the tuple (tuneX, [(position, alphaX),…],[(position,betaX),…] ). It overloads the getRingTwissDataX(p,m) method from the parent MATRIX_Lattice class.

getRingTwissDataY()[source]#: Returns the tuple (tuneY, [(position, alphaY),…],[(position,betaY),…] ). It overloads the getRingTwissDataY(p,m) method from the parent MATRIX_Lattice class.

getTransferDispersionDataX(disp, disp_p)[source]#: Returns the tuple ([(position, dispX),…],[(position,disp_pX),…] ). It overloads the getRingDispersionDataX(p,m) method from the parent MATRIX_Lattice class.

getTransferDispersionDataY(disp, disp_p)[source]#: Returns the tuple ([(position, dispY),…],[(position,disp_pY),…] ). It overloads the getRingDispersionDataY(p,m) method from the parent MATRIX_Lattice class.

getTransferTwissDataX(alpha_x, beta_x)[source]#: Returns the tuple (tuneX, [(position, alphaX),…],[(position,betaX),…] ). It overloads the getRingTwissDataX(p,m) method from the parent MATRIX_Lattice class.

getTransferTwissDataY(alpha_y, beta_y)[source]#: Returns the tuple (tuneY, [(position, alphaY),…],[(position,betaY),…] ). It overloads the getRingTwissDataY(p,m) method from the parent MATRIX_Lattice class.

rebuild(Ekin=- 1.0)[source]#