TwissAnalysis#

class orbit.bunch_generators.TwissAnalysis(nD)[source]#

Bases: object

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. There is a c++ replacement for this class BunchTwissAnalysis in the orbit/BunchDiagnostics dir.

Methods Summary

account(arr_v)

Accounts the data.

getAvgU_UP(d)

Returns the (u_avg,up_avg) parameters in the array [u,up] for the dimension d.

getMaxU_UP(d)

Returns the (u_max,up_max) parameters in the array [u,up] for the dimension d.

getMinU_UP(d)

Returns the (u_min,up_min) parameters in the array [u,up] for the dimension d.

getRmsU_UP(d)

Returns the (rms u,rms up) parameters in the array [u,up] for the dimension d.

getTwiss(d)

Returns the twiss parameters in the array [alpha,beta,gamma, emittance] for the dimension d.

init()

Initilizes the analysis.

Methods Documentation

account(arr_v)[source]#

Accounts the data. The arr_v should be a list of 2, 4, or 6 size.

getAvgU_UP(d)[source]#

Returns the (u_avg,up_avg) parameters in the array [u,up] for the dimension d.

getMaxU_UP(d)[source]#

Returns the (u_max,up_max) parameters in the array [u,up] for the dimension d.

getMinU_UP(d)[source]#

Returns the (u_min,up_min) parameters in the array [u,up] for the dimension d.

getRmsU_UP(d)[source]#

Returns the (rms u,rms up) parameters in the array [u,up] for the dimension d.

getTwiss(d)[source]#

Returns the twiss parameters in the array [alpha,beta,gamma, emittance] for the dimension d.

init()[source]#

Initilizes the analysis.