beam_parameters_factory module

Define a function to generate a BeamParameters for Envelope3D.

class BeamParametersFactoryEnvelope3D(is_3d, is_multipart, beam_kwargs)

Bases: BeamParametersFactory

A class holding method to generate BeamParameters.

Parameters:

• is_3d (bool)

• is_multipart (bool)

• beam_kwargs (BeamKwargs)

factory_method(sigma_in, z_abs, gamma_kin, transfer_matrix, element_to_index)

Create the BeamParameters object.

Parameters:

• sigma_in (ndarray)

• z_abs (ndarray)

• gamma_kin (ndarray)

• transfer_matrix (TransferMatrix)

• element_to_index (ELEMENT_TO_INDEX_T)

Return type:

BeamParameters

_abc_impl = <_abc._abc_data object at 0x7318fb572000>