field_helpers module

Define functions to compute 1D longitudinal electric fields.

This will eventually replace core/em_fields/helper.py

null_field_1d(pos)

Define a null electric/magnetic field.

Parameters:

pos (Any)

Return type:

float

create_1d_field_func(field_values, corresponding_positions)

Create the function to get spatial component of electric field.

Parameters:

• field_values (ndarray)

• corresponding_positions (ndarray)

Return type:

Callable[[float], float]

_evaluate_1d_field(pos, field_values, corresponding_positions)

Interpolate an electric/magnetic 1D field file.

Parameters:

• pos (float)

• field_values (ndarray)

• corresponding_positions (ndarray)

Return type:

float

normalized_e_1d(pos, e_func, phi, phi_0)

Compute electric field, normalized.

Parameters:

• pos (float)

• e_func (Callable[[float], float])

• phi (float)

• phi_0 (float)

Return type:

float

normalized_e_1d_complex(pos, e_func, phi, phi_0)

Compute electric field, normalized.

Parameters:

• pos (float)

• e_func (Callable[[float], float])

• phi (float)

• phi_0 (float)

Return type:

complex

e_1d(pos, e_func, phi, amplitude, phi_0)

Compute normed 1D electric field.

Parameters:

• pos (float)

• e_func (Callable[[float], float])

• phi (float)

• amplitude (float)

• phi_0 (float)

Return type:

float

e_1d_complex(pos, e_func, phi, amplitude, phi_0)

Compute normed 1D electric field.

Parameters:

• pos (float)

• e_func (Callable[[float], float])

• phi (float)

• amplitude (float)

• phi_0 (float)

Return type:

complex

shifted_e_spat(e_spat, z_shift, z_pos)

Shift electric field by z_shift.

Parameters:

• e_spat (Callable[[float], float])

• z_shift (float)

• z_pos (float)

Return type:

float