pysrw.magnets.predefinedUndulator

pysrw.magnets.predefinedUndulator#

pysrw.magnets.predefinedUndulator(undType, energy, centerCoord=[0, 0, 0])[source]#

Create a (planar) undulator from the list of known devices PREDEFINED_UNDULATORS.

Parameters:
  • undType – the name of the known undulator.

  • energy – the beam energy in GeV.

  • centerCoord (optional) – the [x,y,z] of the dipole centre. Defaults to [0,0,0].

Returns:

the predefined (planar) undulator.

Return type:

UndulatorPlanar