phase_space_beam_parameters module

Handle the beam parameters of a single phase space.

For a list of the units associated with every parameter, see Units and conventions.

Note

In this module, angles are stored in deg, not in rad!

class PhaseSpaceBeamParameters(phase_space_name, eps_no_normalization, eps_normalized, envelopes=None, twiss=None, sigma=None, tm_cumul=None, mismatch_factor=None)

Bases: IPhaseSpaceBeamParameters

Hold Twiss, emittance, envelopes of a single phase-space.

Parameters:

• phase_space_name (Literal['phiw', 'phiw99', 't', 'x', 'x99', 'y', 'y99', 'z', 'zdelta'])

• eps_no_normalization (ndarray)

• eps_normalized (ndarray)

• envelopes (ndarray | None, default: None)

• twiss (ndarray | None, default: None)

• sigma (ndarray | None, default: None)

• tm_cumul (ndarray | None, default: None)

• mismatch_factor (ndarray | None, default: None)

eps_no_normalization: ndarray

eps_normalized: ndarray

mismatch_factor: ndarray | None = None

classmethod from_cumulated_transfer_matrices(phase_space_name, sigma_in, tm_cumul, gamma_kin, beta_kin, beam_kwargs)

Compute \(\sigma\) matrix, and everything from it.

Parameters:

• phase_space_name (str)

• sigma_in (ndarray)

• tm_cumul (ndarray)

• gamma_kin (ndarray)

• beta_kin (ndarray)

• beam_kwargs (dict[str, Any])

Return type:

Self

classmethod from_sigma(phase_space_name, sigma, gamma_kin, beta_kin, beam_kwargs, **kwargs)

Compute Twiss, eps, envelopes just from sigma matrix.

Parameters:

• phase_space_name (str)

• sigma (ndarray)

• gamma_kin (ndarray)

• beta_kin (ndarray)

• beam_kwargs (dict[str, Any])

• kwargs (ndarray)

Return type:

Self

classmethod from_other_phase_space(other_phase_space, phase_space_name, gamma_kin, beta_kin, beam_kwargs, **kwargs)

Fully initialize from another phase space.

Parameters:

• other_phase_space (Self)

• phase_space_name (str)

• gamma_kin (ndarray)

• beta_kin (ndarray)

• beam_kwargs (dict[str, Any])

• kwargs (ndarray)

Return type:

Self

classmethod from_averaging_x_and_y(phase_space_name, x_space, y_space)

Create average transverse phase space from [xx’] and [yy’].

eps is always initialized. mismatch_factor is calculated if it was already calculated in x_space and y_space.

Parameters:

• phase_space_name (str)

• x_space (Self)

• y_space (Self)

Return type:

Self

property alpha: ndarray | None

Get first column of self.twiss.

property beta: ndarray | None

Get second column of self.twiss.

property gamma: ndarray | None

Get third column of self.twiss.

property envelope_pos: ndarray | None

Get first column of self.envelopes.

__init__(phase_space_name, eps_no_normalization, eps_normalized, envelopes=None, twiss=None, sigma=None, tm_cumul=None, mismatch_factor=None)

Parameters:

• phase_space_name (Literal['phiw', 'phiw99', 't', 'x', 'x99', 'y', 'y99', 'z', 'zdelta'])

• eps_no_normalization (ndarray)

• eps_normalized (ndarray)

• envelopes (ndarray | None, default: None)

• twiss (ndarray | None, default: None)

• sigma (ndarray | None, default: None)

• tm_cumul (ndarray | None, default: None)

• mismatch_factor (ndarray | None, default: None)

_abc_impl = <_abc._abc_data object at 0x73dca86e6380>

property envelope_energy: ndarray | None

Get second column of self.envelopes.

property eps: ndarray

Return the normalized emittance.

property non_norm_eps: ndarray

Return the non-normalized emittance.

property sigma_in: ndarray

Return the first \(\sigma\) beam matrix.

set_mismatch(reference_phase_space, reference_z_abs, z_abs, raise_missing_twiss_error=True, **mismatch_kw)

Compute and set the mismatch with reference_phase_space.

Parameters:

• reference_phase_space (Self) – Beam parameters in the same phase space, corresponding to the reference linac.

• reference_z_abs (ndarray) – Positions corresponding to reference_phase_space.

• z_abs (ndarray) – Positions in the linac under study.

• raise_missing_twiss_error (bool, default: True) – If set to True and the Twiss parameters were not calculated in current phase space, raise an error.

• mismatch_kw (bool) – Keyword arguments passed to the function computing mismatch factor.

Return type:

None