util.converters module

All functions to change units.

emittance(eps_orig: float | ndarray, key: str, gamma_kin: float | ndarray | None = None, beta_kin: float | ndarray | None = None, lam: float | ndarray | None = None, e_0: float | ndarray | None = None) → float | ndarray

Convert emittance from a phase space to another, or handle norm.

energy(energy_in: float | ndarray, key: str, q_over_m: float | None = None, m_over_q: float | None = None, e_rest: float | None = None) → float | ndarray

Convert energy or Lorentz factor into another related quantity.

longitudinal(long_in: float | ndarray, ene: float | ndarray, key: str, e_rest: float | None = None) → float | ndarray

Convert energies between longitudinal phase spaces.

position(pos_in: float | ndarray, beta: float | ndarray, key: str, omega: float | None = None) → float | ndarray

Phase/position converters.

twiss(twiss_orig: ndarray, gamma_kin: float | ndarray, key: str, lam: float | ndarray | None = None, e_0: float | ndarray | None = None, beta_kin: float | ndarray | None = None) → ndarray

Convert Twiss array from a phase space to another.