pysrw.magnets.Dipole

class pysrw.magnets.Dipole(energy, coreL, edgeL, magField=None, bendingR=None, centerCoord=[0, 0, 0])

Bases: Magnet

__init__(energy, coreL, edgeL, magField=None, bendingR=None, centerCoord=[0, 0, 0])

A dipole magnet with a decaying fringe field.

Parameters:

• energy – beam energy in GeV.

• coreL – dipole magnetic length.

• edgeL – characteristic length of the fringe field. If not known, pass yoke diameter as rough estimate. magField (optional): dipole constant field in T. Ignored if bendingR is passed as well.

• bendingR (optional) – particle bending radius. If provided, the magField is computed from the bending radius.

• centerCoord (optional) – magnet centre position. Defaults to [0, 0, 0].

Methods

__init__(energy, coreL, edgeL[, magField, ...])	A dipole magnet with a decaying fringe field.
getLambdaCritical()	Get the dipole critical wavelength.

getLambdaCritical()

Get the dipole critical wavelength.

Returns:

\(\lambda_c\) in nanometers.

Return type:

float