mxcubecore.HardwareObjects.ESRF.ESRFEnergyScan

Example xml_ configuration:

<object class="ESRF.ESRFXRFSpectrum">
  <object href="/bliss" role="controller"/>
  <cfgfile>/users/blissadm/local/beamline_configuration/misc/15keV.cfg</cfgfile>
  <default_integration_time>3</default_integration_time>
  <default_energy_range>[2.0, 15]</default_energy_range>
  <cfg_energies>[15]</cfg_energies>
</object>

Functions

store_energy_scan_thread(db_conn, scan_info)

Classes

ESRFEnergyScan(name)
GetStaticParameters(config_file, element, edge)

class mxcubecore.HardwareObjects.ESRF.ESRFEnergyScan.ESRFEnergyScan(name)

Bases: AbstractEnergyScan

cancelEnergyScan(*args)

Called by queue_entry.py. To be removed

choose_attenuation()

Choose the appropriate attenuation to execute the scan

close_fast_shutter()

Close the fast shutter.

do_chooch(elt: str, edge: str, directory: str, archive_directory: str, prefix: str)

Execute peak and IP calculation with chooch. :param elt: Element acrony as in the periodic table of elements. :type elt: str :param edge: Edge like (K, L1, L2, L3). :type edge: str :param directory: raw data directory (fill path). :type directory: str :param archive_director: archive data directory (fill path). :type archive_director: str :param prefix: File root prefix. :type prefix: str

Parameters:

• elt (str) –

• edge (str) –

• directory (str) –

• archive_directory (str) –

• prefix (str) –

energy_scan_hook(energy_scan_parameters: dict)

Execute actions, required before running the raw scan(like changing undulator gaps, move to a given energy… These are in general beamline specific actions.

Parameters:

energy_scan_parameters (dict) –

escan_cleanup()

Cleanup actions.

escan_postscan()

Actions done after the scan finished.

escan_prepare()

Set the nesessary equipment in position for the scan.

execute_command(command_name, *args, **kwargs)

Execute command.

Parameters:

• command_name (str) – Command name.

• *args (tuple) – Arguments to pass through to the command to be executed.

• **kwargs (Dict[str, Any]) – Named arguments to pass through to the

• executed. (command to be) –

Raises:

AttributeError – If command not found.

Returns:

Execution output.

Return type:

Any

execute_energy_scan(energy_scan_parameters: dict)

Execute the raw scan sequence. Here is where you pass whatever parameters you need to run the raw scan (e.g start/end energy, counting time, energy step…).

Parameters:

energy_scan_parameters (dict) –

get_static_parameters(config_file: str, element: str, edge: str) → dict

Get the static parameters for form the config file. :param config_file: File to read the configuration from (full path). :type config_file: str :param element: Element acronym as in the periodic table of elements. :type element: str :param edge: edge line (K, L1, L2, L3) :type edge: str

Parameters:

• config_file (str) –

• element (str) –

• edge (str) –

Return type:

dict

init()

Initialisation

open_fast_shutter()

Open the fast shutter.

set_mca_roi(eroi_min, eroi_max)

Configure the fluorescent detector ROI. The input is min/max energy.