orbit.bunch_generators#

Classes#

TwissContainer(alpha, beta, emittance)

Keeps the twiss paremeters alpha, beta and the emittance. Calculates the normalized value (u**2+(alpha*u + beta*u')**2)/(beta*emittance), which is (gamma*u**2+2*alpha*u*u'+beta*u'**2)/(emittance). Translates the normalized values u and up to the non-normalized ones.

TwissAnalysis(nD)

Calculates the rms twiss parameters for 1D,2D, and 3D distributions by using the set of (x,xp), (x,xp,y,yp), and (x,xp,y,yp,z,zp) points.

GaussDist1D([twiss, cut_off])

Generates the 1D Gauss distribution.

GaussDist2D([twissX, twissY, cut_off])

Generates the 2D Gauss distribution.

GaussDist3D([twissX, twissY, twissZ, cut_off])

Generates the 3D Gauss distribution.

KVDist1D([twiss])

Generates the 1D KV-distribution.

KVDist2D([twissX, twissY])

Generates the 2D KV-distribution.

KVDist3D([twissX, twissY, twissZ])

Generates the 3D KV-distribution.The input emittance in the TwissConatainer is a rms emittance.

WaterBagDist1D([twiss])

Generates the Water Bag 1D distribution.The input emittance in the TwissConatainer is a rms emittance.

WaterBagDist2D([twissX, twissY])

Generates the Water Bag 2D distribution.

WaterBagDist3D([twissX, twissY, twissZ])

Generates the Water Bag 3D distribution.

Class Inheritance Diagram#

Inheritance diagram of orbit.bunch_generators.distribution_generators.TwissContainer, orbit.bunch_generators.distribution_generators.TwissAnalysis, orbit.bunch_generators.distribution_generators.GaussDist1D, orbit.bunch_generators.distribution_generators.GaussDist2D, orbit.bunch_generators.distribution_generators.GaussDist3D, orbit.bunch_generators.distribution_generators.KVDist1D, orbit.bunch_generators.distribution_generators.KVDist2D, orbit.bunch_generators.distribution_generators.KVDist3D, orbit.bunch_generators.distribution_generators.WaterBagDist1D, orbit.bunch_generators.distribution_generators.WaterBagDist2D, orbit.bunch_generators.distribution_generators.WaterBagDist3D