initial_phase_space_beam_parameters module

Handle the initial 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 InitialPhaseSpaceBeamParameters(phase_space_name, eps_no_normalization, eps_normalized, envelopes=None, twiss=None, sigma=None, tm_cumul=None, mismatch_factor=None)[source]

Bases: IPhaseSpaceBeamParameters

Hold Twiss, emittance, envelopes of single phase-space @ single pos.

Parameters:

phase_space_name (Literal['phiw', 'phiw99', 't', 'x', 'x99', 'y', 'y99', 'z', 'zdelta'])
eps_no_normalization (float)
eps_normalized (float)
envelopes (ndarray[tuple[Any, ...], dtype[double]] | None, default: None)
twiss (ndarray[tuple[Any, ...], dtype[double]] | None, default: None)
sigma (ndarray[tuple[Any, ...], dtype[double]] | None, default: None)
tm_cumul (ndarray[tuple[Any, ...], dtype[double]] | None, default: None)
mismatch_factor (float | None, default: None)

eps_no_normalization: float

eps_normalized: float

mismatch_factor: float | None = None

__post_init__()[source]

Ensure that the phase space exists.

Return type:: None

classmethod from_sigma(phase_space_name, sigma, gamma_kin, beta_kin, beam_kwargs, **kwargs)[source]

Compute Twiss, eps, envelopes just from sigma matrix.

Parameters:

phase_space_name (Literal['phiw', 'phiw99', 't', 'x', 'x99', 'y', 'y99', 'z', 'zdelta'])
sigma (ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])
gamma_kin (float)
beta_kin (float)
beam_kwargs (BeamKwargs)
kwargs (ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

Return type:

Self

classmethod from_other_phase_space(other_phase_space, phase_space_name, gamma_kin, beta_kin, beam_kwargs, **kwargs)[source]

Fully initialize from another phase space.

Parameters:

other_phase_space (Self)
phase_space_name (Literal['phiw', 'phiw99', 't', 'x', 'x99', 'y', 'y99', 'z', 'zdelta'])
gamma_kin (float)
beta_kin (float)
beam_kwargs (BeamKwargs)
kwargs (ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]])

Return type:

Self

property alpha: float | None: Get first element of self.twiss.

property beta: float | None: Get second element of self.twiss.

property gamma: float | None: Get third element of self.twiss.

__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 (float)
eps_normalized (float)
envelopes (ndarray[tuple[Any, ...], dtype[double]] | None, default: None)
twiss (ndarray[tuple[Any, ...], dtype[double]] | None, default: None)
sigma (ndarray[tuple[Any, ...], dtype[double]] | None, default: None)
tm_cumul (ndarray[tuple[Any, ...], dtype[double]] | None, default: None)
mismatch_factor (float | None, default: None)

Return type:

None

_abc_impl = <_abc._abc_data object at 0x7318fc04c8c0>

property envelope_pos: float | None: Get first element of self.envelopes.

property envelope_energy: float | None: Get second element of self.envelopes.

property eps: float: Return the normalized emittance.

property non_norm_eps: float: Return the normalized emittance.