mxcubecore.HardwareObjects.abstract.AbstractEnergyScan#
Classes
|
Energy Scan abstract class |
- class mxcubecore.HardwareObjects.abstract.AbstractEnergyScan.AbstractEnergyScan(name)[source]#
Bases:
HardwareObjectEnergy Scan abstract class
- choose_attenuation()[source]#
Procedure to set the minimal attenuation in order no preserve the sample. Should be done at the energy after the edge.
- energy_scan_hook(energy_scan_parameters)[source]#
Execute actions, required before running the raw scan(like changing undulator gaps, move to a given energy… These are in general beamline specific actions.
- escan_prepare()[source]#
Set the nesessary equipment in position for the scan. No need to know the scan paramets.
- execute_energy_scan(energy_scan_parameters)[source]#
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…).
- get_elements()[source]#
Get the configured in the file elements to be used :returns: Dictionary {“symbol”: str, “energy”: str} :rtype: (dict)
- get_static_parameters(config_file, element, edge)[source]#
Get any parameters, which are known before hand. Some of them are known from the theory, like the peak energy, others are equipment specific like the lower/upper ROI limits of the fluorescence detector. Usually these parameters are pre-defined in a file, but can also be calculated. The function should return a distionary with at least defined {‘edgeEnergy’: peak_energy} member, where ‘edgeEnergy’ is a compulsory key. It is convenient to put in the same dictionary the remote energy, the ROI min/max values. There are few more reserved key names: ‘eroi_min’, ‘eroi_max’ - min and max ROI limits if you want to set one. ‘findattEnergy’ - energy to move to if you want to choose the attenuation for the scan.