core.beam_parameters package

Store and compute beam parameters in all the phase spaces.

In particular, this subpackage handles the calculation of the Twiss parameters, the emittances, the mismatch factors, the \(\sigma\) matrix.

Todo

Remove tracewin command from BeamParameters

Subpackages

• core.beam_parameters.phase_space package
  • Submodules
    • core.beam_parameters.phase_space.i_phase_space_beam_parameters module
      • IMPLEMENTED_PHASE_SPACES
      • IPhaseSpaceBeamParameters
    • core.beam_parameters.phase_space.initial_phase_space_beam_parameters module
      • InitialPhaseSpaceBeamParameters
    • core.beam_parameters.phase_space.phase_space_beam_parameters module
      • PhaseSpaceBeamParameters

Submodules

• core.beam_parameters.beam_parameters module
  • BeamParameters
    • BeamParameters.z_abs
    • BeamParameters.gamma_kin
    • BeamParameters.beta_kin
    • BeamParameters.sigma_in
    • BeamParameters.element_to_index
    • BeamParameters.__init__()
    • BeamParameters.__post_init__()
    • BeamParameters._create_tracewin_command()
    • BeamParameters._get_phase_spaces()
    • BeamParameters._set_mismatch_for_transverse()
    • BeamParameters.beta_kin
    • BeamParameters.element_to_index()
    • BeamParameters.gamma_kin
    • BeamParameters.get()
    • BeamParameters.set_mismatches()
    • BeamParameters.sigma
    • BeamParameters.sigma_in
    • BeamParameters.sub_sigma_in()
    • BeamParameters.tracewin_command
    • BeamParameters.z_abs
  • _to_float_if_necessary()
• core.beam_parameters.factory module
  • BeamParametersFactory
    • BeamParametersFactory.__init__()
    • BeamParametersFactory._abc_impl
    • BeamParametersFactory._check_and_set_arrays()
    • BeamParametersFactory._check_sigma_in()
    • BeamParametersFactory._determine_phase_spaces()
    • BeamParametersFactory._set_from_other_phase_space()
    • BeamParametersFactory._set_from_sigma()
    • BeamParametersFactory._set_from_transfer_matrix()
    • BeamParametersFactory._set_only_emittance()
    • BeamParametersFactory._set_transverse_from_x_and_y()
    • BeamParametersFactory.factory_method()
  • InitialBeamParametersFactory
    • InitialBeamParametersFactory.__init__()
    • InitialBeamParametersFactory._abc_impl
    • InitialBeamParametersFactory._initial_beam_parameters_kw()
    • InitialBeamParametersFactory._initial_phase_space_beam_parameters_kw()
    • InitialBeamParametersFactory._set_from_other_phase_space()
    • InitialBeamParametersFactory._set_from_sigma()
    • InitialBeamParametersFactory.factory_new()
    • InitialBeamParametersFactory.factory_subset()
• core.beam_parameters.helper module
  • envelopes_from_sigma()
  • envelopes_from_twiss_eps()
  • eps_from_other_phase_space()
  • eps_from_sigma()
  • mismatch_from_arrays()
  • reconstruct_sigma()
  • resample_twiss_on_fix()
  • sigma_from_transfer_matrices()
  • twiss_from_other_phase_space()
  • twiss_from_sigma()
• core.beam_parameters.initial_beam_parameters module
  • InitialBeamParameters
    • InitialBeamParameters.z_abs
    • InitialBeamParameters.gamma_kin
    • InitialBeamParameters.beta_kin
    • InitialBeamParameters.__init__()
    • InitialBeamParameters.__post_init__()
    • InitialBeamParameters._create_tracewin_command()
    • InitialBeamParameters.beta_kin
    • InitialBeamParameters.gamma_kin
    • InitialBeamParameters.get()
    • InitialBeamParameters.has()
    • InitialBeamParameters.sigma
    • InitialBeamParameters.tracewin_command
    • InitialBeamParameters.z_abs
  • phase_space_name_hidden_in_key()
  • separate_var_from_phase_space()