core.beam_parameters.phase_space package

Define objects to store the beam parameters of a phase space.

The stored elements are the emittances, the Twiss parameters, the transfer and \(\sigma\) matrices, the mismatch factor. InitialPhaseSpaceBeamParameters holds the beam parameters at a single position. In particular, at the start of the portion of the linac under study. PhaseSpaceBeamParameters holds the beam parameters at several positions. In particular, in the full portion of the linac under study at the end of a calculation. IPhaseSpaceBeamParameters holds the attributes and methods that are common between those two objects.

Submodules

• core.beam_parameters.phase_space.i_phase_space_beam_parameters module
  • IMPLEMENTED_PHASE_SPACES
  • IPhaseSpaceBeamParameters
    • IPhaseSpaceBeamParameters.__init__()
    • IPhaseSpaceBeamParameters.__post_init__()
    • IPhaseSpaceBeamParameters._abc_impl
    • IPhaseSpaceBeamParameters.alpha
    • IPhaseSpaceBeamParameters.beta
    • IPhaseSpaceBeamParameters.envelope_energy
    • IPhaseSpaceBeamParameters.envelope_pos
    • IPhaseSpaceBeamParameters.envelopes
    • IPhaseSpaceBeamParameters.eps
    • IPhaseSpaceBeamParameters.eps_no_normalisation
    • IPhaseSpaceBeamParameters.eps_normalized
    • IPhaseSpaceBeamParameters.from_other_phase_space()
    • IPhaseSpaceBeamParameters.from_sigma()
    • IPhaseSpaceBeamParameters.gamma
    • IPhaseSpaceBeamParameters.mismatch_factor
    • IPhaseSpaceBeamParameters.phase_space_name
    • IPhaseSpaceBeamParameters.sigma
    • IPhaseSpaceBeamParameters.tm_cumul
    • IPhaseSpaceBeamParameters.twiss
• core.beam_parameters.phase_space.initial_phase_space_beam_parameters module
  • InitialPhaseSpaceBeamParameters
    • InitialPhaseSpaceBeamParameters.__init__()
    • InitialPhaseSpaceBeamParameters.__post_init__()
    • InitialPhaseSpaceBeamParameters._abc_impl
    • InitialPhaseSpaceBeamParameters.alpha
    • InitialPhaseSpaceBeamParameters.beta
    • InitialPhaseSpaceBeamParameters.envelope_energy
    • InitialPhaseSpaceBeamParameters.envelope_pos
    • InitialPhaseSpaceBeamParameters.eps
    • InitialPhaseSpaceBeamParameters.eps_no_normalisation
    • InitialPhaseSpaceBeamParameters.eps_normalized
    • InitialPhaseSpaceBeamParameters.from_other_phase_space()
    • InitialPhaseSpaceBeamParameters.from_sigma()
    • InitialPhaseSpaceBeamParameters.gamma
    • InitialPhaseSpaceBeamParameters.mismatch_factor
• core.beam_parameters.phase_space.phase_space_beam_parameters module
  • PhaseSpaceBeamParameters
    • PhaseSpaceBeamParameters.__init__()
    • PhaseSpaceBeamParameters._abc_impl
    • PhaseSpaceBeamParameters.alpha
    • PhaseSpaceBeamParameters.beta
    • PhaseSpaceBeamParameters.envelope_energy
    • PhaseSpaceBeamParameters.envelope_pos
    • PhaseSpaceBeamParameters.eps
    • PhaseSpaceBeamParameters.eps_no_normalisation
    • PhaseSpaceBeamParameters.eps_normalized
    • PhaseSpaceBeamParameters.from_averaging_x_and_y()
    • PhaseSpaceBeamParameters.from_cumulated_transfer_matrices()
    • PhaseSpaceBeamParameters.from_other_phase_space()
    • PhaseSpaceBeamParameters.from_sigma()
    • PhaseSpaceBeamParameters.gamma
    • PhaseSpaceBeamParameters.mismatch_factor
    • PhaseSpaceBeamParameters.set_mismatch()
    • PhaseSpaceBeamParameters.sigma_in