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
- phase_space package
- Submodules
- i_phase_space_beam_parameters module
IPhaseSpaceBeamParametersIPhaseSpaceBeamParameters.phase_space_nameIPhaseSpaceBeamParameters.eps_no_normalizationIPhaseSpaceBeamParameters.eps_normalizedIPhaseSpaceBeamParameters.envelopesIPhaseSpaceBeamParameters.twissIPhaseSpaceBeamParameters.sigmaIPhaseSpaceBeamParameters.tm_cumulIPhaseSpaceBeamParameters.mismatch_factorIPhaseSpaceBeamParameters.__post_init__()IPhaseSpaceBeamParameters.from_sigma()IPhaseSpaceBeamParameters.from_other_phase_space()IPhaseSpaceBeamParameters.__str__()IPhaseSpaceBeamParameters.alphaIPhaseSpaceBeamParameters.betaIPhaseSpaceBeamParameters.gammaIPhaseSpaceBeamParameters.__init__()IPhaseSpaceBeamParameters._abc_implIPhaseSpaceBeamParameters.envelope_posIPhaseSpaceBeamParameters.envelope_energyIPhaseSpaceBeamParameters.epsIPhaseSpaceBeamParameters.non_norm_eps
- initial_phase_space_beam_parameters module
InitialPhaseSpaceBeamParametersInitialPhaseSpaceBeamParameters.eps_no_normalizationInitialPhaseSpaceBeamParameters.eps_normalizedInitialPhaseSpaceBeamParameters.mismatch_factorInitialPhaseSpaceBeamParameters.__post_init__()InitialPhaseSpaceBeamParameters.from_sigma()InitialPhaseSpaceBeamParameters.from_other_phase_space()InitialPhaseSpaceBeamParameters.alphaInitialPhaseSpaceBeamParameters.betaInitialPhaseSpaceBeamParameters.gammaInitialPhaseSpaceBeamParameters.__init__()InitialPhaseSpaceBeamParameters._abc_implInitialPhaseSpaceBeamParameters.envelope_posInitialPhaseSpaceBeamParameters.envelope_energyInitialPhaseSpaceBeamParameters.epsInitialPhaseSpaceBeamParameters.non_norm_eps
- phase_space_beam_parameters module
PhaseSpaceBeamParametersPhaseSpaceBeamParameters.eps_no_normalizationPhaseSpaceBeamParameters.eps_normalizedPhaseSpaceBeamParameters.mismatch_factorPhaseSpaceBeamParameters.from_cumulated_transfer_matrices()PhaseSpaceBeamParameters.from_sigma()PhaseSpaceBeamParameters.from_other_phase_space()PhaseSpaceBeamParameters.from_averaging_x_and_y()PhaseSpaceBeamParameters.alphaPhaseSpaceBeamParameters.betaPhaseSpaceBeamParameters.gammaPhaseSpaceBeamParameters.envelope_posPhaseSpaceBeamParameters.__init__()PhaseSpaceBeamParameters._abc_implPhaseSpaceBeamParameters.envelope_energyPhaseSpaceBeamParameters.epsPhaseSpaceBeamParameters.non_norm_epsPhaseSpaceBeamParameters.sigma_inPhaseSpaceBeamParameters.set_mismatch()
- i_phase_space_beam_parameters module
- Submodules
Submodules
- beam_parameters module
BeamParametersBeamParameters.z_absBeamParameters.gamma_kinBeamParameters.beta_kinBeamParameters.sigma_inBeamParameters.element_to_index()BeamParameters.__post_init__()BeamParameters.get()BeamParameters.sigmaBeamParameters.sub_sigma_in()BeamParameters.tracewin_commandBeamParameters._create_tracewin_command()BeamParameters.set_mismatches()BeamParameters._get_phase_spaces()BeamParameters._set_mismatch_for_transverse()BeamParameters.__init__()
_to_float_if_necessary()
- factory module
BeamParametersFactoryBeamParametersFactory.__init__()BeamParametersFactory._determine_phase_spaces()BeamParametersFactory.factory_method()BeamParametersFactory._check_and_set_arrays()BeamParametersFactory._check_sigma_in()BeamParametersFactory._set_from_other_phase_space()BeamParametersFactory._set_only_emittance()BeamParametersFactory._set_from_transfer_matrix()BeamParametersFactory._set_transverse_from_x_and_y()BeamParametersFactory._set_from_sigma()BeamParametersFactory._abc_impl
InitialBeamParametersFactoryInitialBeamParametersFactory.__init__()InitialBeamParametersFactory.factory_new()InitialBeamParametersFactory.factory_subset()InitialBeamParametersFactory._initial_beam_parameters_kw()InitialBeamParametersFactory._initial_phase_space_beam_parameters_kw()InitialBeamParametersFactory._set_from_sigma()InitialBeamParametersFactory._set_from_other_phase_space()InitialBeamParametersFactory._abc_impl
- helper module
reconstruct_sigma()eps_from_sigma()twiss_from_sigma()envelopes_from_sigma()sigma_from_transfer_matrices()envelopes_from_twiss_eps()eps_from_other_phase_space()twiss_from_other_phase_space()mismatch_from_arrays()resample_twiss_on_fix()phase_space_name_hidden_in_key()separate_var_from_phase_space()
- initial_beam_parameters module
InitialBeamParametersInitialBeamParameters.z_absInitialBeamParameters.gamma_kinInitialBeamParameters.beta_kinInitialBeamParameters.__post_init__()InitialBeamParameters.__str__()InitialBeamParameters.has()InitialBeamParameters.get()InitialBeamParameters.tracewin_commandInitialBeamParameters.sigmaInitialBeamParameters._create_tracewin_command()InitialBeamParameters.__init__()