dodal.devices.undulator.UndulatorInKeV#

class dodal.devices.undulator.UndulatorInKeV[source]#

An Undulator-type insertion device, used to control photon emission at a given beam energy. This class expects energy [keV] passed in set method and does conversion to gap internally, for which it requires path to lookup table file in constructor.

Parameters:

  • prefix (str)

  • id_gap_lookup_table_path (str, default: '/dev/null')

  • poles (int | None, default: None)

  • length (float | None, default: None)

  • undulator_period (int | None, default: None)

  • baton (Baton | None, default: None)

  • name (str, default: '')

Constructor

Parameters:

  • prefix (str) – PV prefix

  • id_gap_lookup_table_path (str) – Path to a lookup table file

  • poles (int, optional) – Number of magnetic poles built into the undulator

  • length (float, optional) – Length of the undulator in meters

  • undulator_period (int, optional) – Undulator period

  • baton (optional) – Baton object if provided.

  • name (str, optional) – Name for device. Defaults to “”.

Methods

set(value)

Check conditions and Set undulator gap to a given energy in keV

Attributes

set(value: float)[source]#

Check conditions and Set undulator gap to a given energy in keV

Parameters:

value (float) – energy in keV