field70 module

Define the dc field corresponding to FIELD_MAP 70.

This is 3D magnetic field along. Not really implemented as 3D field maps is not implemented, but can serve as a place holder for non-accelerating fields.

class Field70(folder, filename, length_m, z_0=0, flag_cython=False)[source]

Bases: Field

Define a RF field, 1D longitudinal.

Parameters:

  • folder (Path)

  • filename (str)

  • length_m (float)

  • z_0 (float, default: 0)

  • flag_cython (bool, default: False)

extensions: Collection[str] = ('.bsx', '.bsy', '.bsz')
is_implemented: bool = False
__init__(folder, filename, length_m, z_0=0, flag_cython=False)[source]

Instantiate object.

Parameters:

  • folder (Path) – Where the field map files are.

  • filename (str) – The base name of the field map file(s), without extension (as in the FIELD_MAP command).

  • length_m (float) – Length of the field map.

  • z_0 (float, default: 0) – Position of the field map. Used with superpose.

  • flag_cython (bool, default: False) – If Cython field maps should be loaded.

Return type:

None

_load_fieldmap(path, **validity_check_kwargs)[source]

Return dummy fields.

Parameters:

path (Path)

Return type:

tuple[Callable[..., float], Any, int]

_abc_impl = <_abc._abc_data object at 0x7318faaa3fc0>