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.

ElectronAnalyserDetector

Detector for data acquisition of electron analyser.

AbstractAnalyserDriverIO

Driver device that defines signals and readables that should be common to all electron analysers.

EnergyMode

BaseRegion

Generic region model that holds the data.

BaseSequence

Generic sequence model that holds the list of region data.

GenericRegion

alias of BaseRegion[StrictEnum, Union[SupersetEnum, StrictEnum], Union[StrictEnum, float]]

GenericSequence

alias of BaseSequence[BaseRegion[StrictEnum, Union[SupersetEnum, StrictEnum], Union[StrictEnum, float]]]

AbstractEnergySource

Abstract device that wraps an energy source signal and provides common interface via a energy signal.

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.

to_kinetic_energy(value, value_mode, ...)

Convert a value that is binding energy to kinetic energy.
dodal.devices.electron_analyser.base.to_binding_energy(value: float, value_mode: EnergyMode, excitation_energy: float) → float[source]#

Convert a value that is kinetic energy to binding energy.

Parameters:

  • value (float) – The value to convert.

  • value_mode (EnergyMode) – Energy mode of the value. If it is already binding, return the same value. If it is kinetic, convert to binding.

  • excitation_energy (float) – Value to calculate the conversion.

Returns:

Caluclated binding energy value.

Return type:

float

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

Convert a value that is binding energy to kinetic energy.

Parameters:

  • value (float) – The value to convert.

  • value_mode (EnergyMode) – Energy mode of the value. If it is already kinetic, return the same value. If it is binding, convert to kinetic.

  • excitation_energy (float) – Value to calculate the conversion.

Returns:

Caluclated kinetic energy value.

Return type:

float