dodal.devices.electron_analyser.base

Classes

ElectronAnalyserController	Specialised controller for the electron analysers to provide additional setup logic such as selecting the energy source to use from requested region and giving the driver the correct region parameters.
BaseElectronAnalyserDetector	Detector for data acquisition of electron analyser.
ElectronAnalyserDetector	Electron analyser detector with the additional functionality to load a sequence file and create a list of temporary ElectronAnalyserRegionDetector objects.
ElectronAnalyserRegionDetector	Extends electron analyser detector to configure specific region settings before data acquisition.
AbstractAnalyserDriverIO	Driver device that defines signals and readables that should be common to all electron analysers.
EnergyMode
SelectedSource
AbstractBaseRegion	Generic region model that holds the data.
AbstractBaseSequence	Generic sequence model that holds the list of region data.
GenericRegion	alias of AbstractBaseRegion[StrictEnum, Union[SupersetEnum, StrictEnum], Union[StrictEnum, float]]
GenericSequence	alias of AbstractBaseSequence[AbstractBaseRegion[StrictEnum, Union[SupersetEnum, StrictEnum], Union[StrictEnum, float]]]
DualEnergySource	Holds two EnergySource devices and provides a signal to read energy depending on which source is selected.
EnergySource	Wraps a signal that relates to energy and provides common interface via energy signal.

Functions

to_binding_energy(value, value_mode, ...)	Convert a value that is kinetic energy to binding energy. :type value: float :param value: The value to convert. :type value_mode: EnergyMode :param value_mode: Energy mode of the value. If it is already binding, return the same value. If it is kinetic, convert to binding. :type excitation_energy: float :param excitation_energy: Value to calculate the conversion.
to_kinetic_energy(value, value_mode, ...)	Convert a value that is binding energy to kinetic energy. :type value: float :param value: The value to convert. :type value_mode: EnergyMode :param value_mode: Energy mode of the value. If it is already kinetic, return the same value. If it is binding, convert to kinetic. :type excitation_energy: float :param excitation_energy: Value to calculate the conversion.

dodal.devices.electron_analyser.base.to_binding_energy(value: float, value_mode: EnergyMode, excitation_energy: float) → float

Convert a value that is kinetic energy to binding energy. :type value: float :param value: The value to convert. :type value_mode: EnergyMode :param value_mode: Energy mode of the value. If it is already binding, return the

same value. If it is kinetic, convert to binding.

Parameters:

excitation_energy (float) – Value to calculate the conversion.

Return type:

float

Returns:

Caluclated binding energy value

dodal.devices.electron_analyser.base.to_kinetic_energy(value: float, value_mode: EnergyMode, excitation_energy: float) → float

Convert a value that is binding energy to kinetic energy. :type value: float :param value: The value to convert. :type value_mode: EnergyMode :param value_mode: Energy mode of the value. If it is already kinetic, return the

same value. If it is binding, convert to kinetic.

Parameters:

excitation_energy (float) – Value to calculate the conversion.

Return type:

float

Returns:

Caluclated kinetic energy value