toolbox_scs.misc.undulator

Module Contents

Functions

get_undulator_config(run[, park_pos, plot])

Extract the undulator cells configuration from a given run.
toolbox_scs.misc.undulator.get_undulator_config(run, park_pos=62.0, plot=True)[source]

Extract the undulator cells configuration from a given run. The gap size and K factor as well as the magnetic chicane delay and photon energy of colors 1, 2 and 3 are compiled into an xarray Dataset.

Note: This function looks at run control values, it does not reflect any change of values during the run. Do not use to extract configuration when scanning the undulator.

Parameters:

  • run (EXtra-Data DataCollection) – The run containing the undulator information

  • park_pos (float, optional) – The parked position of a cell (i.e. when fully opened)

  • plot (bool, optional) – If True, plot the undulator cells configuration

Returns:

cells – The resulting dataset of the undulator configuration

Return type:

xarray Dataset