i_phase_space_beam_parameters module

Hold the beam parameters in 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!

PHASE_SPACES = ('zdelta', 'z', 'phiw', 'x', 'y', 't', 'phiw99', 'x99', 'y99')

class IPhaseSpaceBeamParameters(phase_space_name: Literal['zdelta', 'z', 'phiw', 'x', 'y', 't', 'phiw99', 'x99', 'y99'], eps_no_normalization: ndarray | float, eps_normalized: ndarray | float, envelopes: ndarray | None = None, twiss: ndarray | None = None, sigma: ndarray | None = None, tm_cumul: ndarray | None = None, mismatch_factor: ndarray | float | None = None)

Bases: ABC

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

phase_space_name: Literal['zdelta', 'z', 'phiw', 'x', 'y', 't', 'phiw99', 'x99', 'y99']

eps_no_normalization: ndarray | float

eps_normalized: ndarray | float

envelopes: ndarray | None = None

twiss: ndarray | None = None

sigma: ndarray | None = None

tm_cumul: ndarray | None = None

mismatch_factor: ndarray | float | None = None

__post_init__() → None: Ensure that the phase space exists.

classmethod from_sigma(phase_space_name: Literal['zdelta', 'z', 'phiw', 'x', 'y', 't', 'phiw99', 'x99', 'y99'], sigma: ndarray, gamma_kin: ndarray | float, beta_kin: ndarray | float, beam_kwargs: dict[str, Any], **kwargs: ndarray) → Self: Compute Twiss, eps, envelopes just from sigma matrix.

classmethod from_other_phase_space(other_phase_space: Self, phase_space_name: Literal['zdelta', 'z', 'phiw', 'x', 'y', 't', 'phiw99', 'x99', 'y99'], gamma_kin: ndarray | float, beta_kin: ndarray | float, beam_kwargs: dict[str, Any], **kwargs: ndarray) → Self: Fully initialize from another phase space.

__str__() → str: Show amplitude of some of the attributes.

abstract property alpha: ndarray | float | None: Get first element/column of self.twiss.

abstract property beta: ndarray | float | None: Get second element/column of self.twiss.

abstract property gamma: ndarray | float | None: Get third element/column of self.twiss.

__init__(phase_space_name: Literal['zdelta', 'z', 'phiw', 'x', 'y', 't', 'phiw99', 'x99', 'y99'], eps_no_normalization: ndarray | float, eps_normalized: ndarray | float, envelopes: ndarray | None = None, twiss: ndarray | None = None, sigma: ndarray | None = None, tm_cumul: ndarray | None = None, mismatch_factor: ndarray | float | None = None) → None

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

abstract property envelope_pos: ndarray | float | None: Get first element/column of self.envelopes.

abstract property envelope_energy: ndarray | float | None: Get second element/column of self.envelopes.

abstract property eps: ndarray | float: Return the normalized emittance.

abstract property non_norm_eps: ndarray | float: Return the non-normalized emittance.