pysrw.magnets.predefinedDipole#
- pysrw.magnets.predefinedDipole(dipoleType, energy, centerCoord=[0, 0, 0])[source]#
Create a dipole from the list of known devices
PREDEFINED_DIPOLES.- Parameters:
dipoleType – the name of the known dipole.
energy – the beam energy, needed to retrieve the field from the bending radius.
centerCoord (optional) – the [x,y,z] of the dipole centre. Defaults to [0,0,0].
- Returns:
the predefined dipole.
- Return type: