converters module

All functions to change units.

Todo

The eps_phiw is not correct. Does not match TraceWin (even if what I compute seems right). Check the zdelta -> phiw conversion.

position(pos_in, beta, key, omega_0_bunch, **beam_kwargs)

Phase/position converters.

Parameters:

• pos_in (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• beta (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• key (str)

• omega_0_bunch (float)

Return type:

float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]

energy(energy_in, key, q_over_m, m_over_q, e_rest_mev, **beam_kwargs)

Convert energy or Lorentz factor into another related quantity.

Todo

q_over_m and m_over_q should not be mandatory arguments if they are not always used.

Parameters:

• energy_in (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• key (str)

• q_over_m (float)

• m_over_q (float)

• e_rest_mev (float)

Return type:

float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]

longitudinal(long_in, ene, key, e_rest_mev, **beam_kwargs)

Convert energies between longitudinal phase spaces.

Parameters:

• long_in (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• ene (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• key (str)

• e_rest_mev (float)

Return type:

float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]

emittance(eps_orig, key, gamma_kin, beta_kin, lambda_bunch, e_rest_mev, **beam_kwargs)

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

Parameters:

• eps_orig (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• key (str)

• gamma_kin (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• beta_kin (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• lambda_bunch (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• e_rest_mev (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

Return type:

float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]

twiss(twiss_orig, gamma_kin, key, lambda_bunch, e_rest_mev, beta_kin=None, **beam_kwargs)

Convert Twiss array from a phase space to another.

Parameters:

• twiss_orig (ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• gamma_kin (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• key (str)

• lambda_bunch (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• e_rest_mev (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

• beta_kin (float | ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]] | None, default: None)

Return type:

ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]