superposed_fields module

Define an object holding several Field.

class SuperposedFields(fields, length_m=0.0, z_0=0.0)[source]

Bases: Field

This object gathers several Field instances.

Parameters:
is_implemented: bool = True
extensions: Collection[str] = ()
__init__(fields, length_m=0.0, z_0=0.0)[source]

Initialize the SuperposedFields.

Parameters:

  • fields (Collection[Field]) – A collection of Field instances.

  • length_m (float, default: 0.0) – The total length of the field in meters.

  • z_0 (float, default: 0.0) – The initial z-position.

Return type:

None

_load_fieldmap(path, **kwargs)[source]

Do not do anything.

Parameters:

path (Path)

Return type:

tuple[Any, Any, int]

_params(amplitudes, phi_0_rels)[source]

Gather all the parameters for a field calculation.

Parameters:
Return type:

zip

e_x(pos, phi, amplitudes, phi_0_rels)[source]

Sum the e_x components from all Field instances at position pos.

Parameters:
Return type:

complex

e_y(pos, phi, amplitudes, phi_0_rels)[source]

Sum the e_y components from all Field instances at position pos.

Parameters:
Return type:

complex

e_z(pos, phi, amplitudes, phi_0_rels, complex_output=True)[source]

Sum the e_z components from all Field instances at position pos.

Parameters:
Return type:

complex | float

b_x(pos, phi, amplitudes, phi_0_rels)[source]

Sum the b_x components from all Field instances at position pos.

Parameters:
Return type:

complex

b_y(pos, phi, amplitudes, phi_0_rels)[source]

Sum the b_y components from all Field instances at position pos.

Parameters:
Return type:

complex

b_z(pos, phi, amplitudes, phi_0_rels)[source]

Sum the b_z components from all Field instances at position pos.

Parameters:
Return type:

complex

partial_e_z(amplitudes, phi_0_rels)[source]

Generate functions for longitudinal transfer matrix calculation.

Parameters:
Return type:

tuple[Callable[[float | tuple[float, float] | tuple[float, float, float], float], complex], Callable[[float | tuple[float, float] | tuple[float, float, float], float], float]]

shift()[source]

Shift the field maps.

Not applicable for SuperposedFields.

Return type:

None

_abc_impl = <_abc._abc_data object at 0x7318fb36f100>