The Beam class

The Beam class is top-level class in KENV. It contains all the beam data.

class kenv.beam.Beam(*, current: float = 0.0, energy: float = 0.0, radius: float = 0.0, radius_x: float = 0.0, radius_y: float = 0.0, rp: float = 0.0, radius_xp: float = 0.0, radius_yp: float = 0.0, normalized_emittance: float = 0.0, normalized_emittance_x: float = 0.0, normalized_emittance_y: float = 0.0, x: float = 0.0, y: float = 0.0, xp: float = 0.0, yp: float = 0.0, larmor_angle: float = 0.0, charge: int = - 1)[source]

Initialization of an electron beam.

Parameters

  • current (float) – Beam current, [A]

  • energy (float) – Beam energy, [MeV]

  • radius (float) – Beam radius, [m]

  • radius_x (float, optional) – Elliptical beam radius along the x-axis, [m]

  • radius_y (float, optional) – Elliptical beam radius along the y-axis, [m]

  • rp (float) – Beam radius prime, [rad]

  • radius_xp (float, optional) – Elliptical beam radius prime along the x-axis, [rad]

  • radius_yp (float, optional) – Elliptical beam radius prime along the y-axis, [rad]

  • normalized_emittance (float) – Beam normalized emittance, [m*rad]

  • normalized_emittance_x (float, optional) – Elliptical beam normalized emittance along the x-axis, [m*rad]

  • normalized_emittance_y (float, optional) – Elliptical beam normalized emittance along the y-axis, [m*rad]

  • x (float, optional) – Offset of the centroid along the x-axis, [m]

  • xp (float, optional) – Centroid rotation in the z-x plane, [rad]

  • y (float, optional) – Offset of the centroid along the y-axis, [m]

  • yp (float, optional) – Centroid rotation in the z-y plane, [rad]

  • larmor_angle (float, optional) – Centroid larmor angle, [rad]

  • charge (int, optional) – Particle charge (dev!)