dodal.devices.electron_analyser.base.AbstractAnalyserDriverIO#

class dodal.devices.electron_analyser.base.AbstractAnalyserDriverIO[source]#

Driver device that defines signals and readables that should be common to all electron analysers. Implementations of electron analyser devices should inherit from this class and define additional specialised signals and methods.

Parameters:

  • prefix (str)

  • acquisition_mode_type (type[TypeVar(TAcquisitionMode, bound= StrictEnum)])

  • lens_mode_type (type[TypeVar(TLensMode, bound= SupersetEnum | StrictEnum)])

  • psu_mode_type (type[TypeVar(TPsuMode, bound= SupersetEnum | StrictEnum)])

  • pass_energy_type (type[TypeVar(TPassEnergy, bound= StrictEnum | float)])

  • name (str, default: '')

Constructor method for setting up electron analyser.

Parameters:

  • prefix (str) – Base PV to connect to EPICS for this device.

  • acquisition_mode_type (type[TypeVar(TAcquisitionMode, bound= StrictEnum)]) – Enum that determines the available acquisition modes for this device.

  • lens_mode_type (type[TypeVar(TLensMode, bound= SupersetEnum | StrictEnum)]) – Enum that determines the available lens mode for this device.

  • psu_mode_type (type[TypeVar(TPsuMode, bound= SupersetEnum | StrictEnum)]) – Enum that determines the available psu modes for this device.

  • pass_energy_type (type[TypeVar(TPassEnergy, bound= StrictEnum | float)]) – Can be enum or float, depends on electron analyser model. If enum, it determines the available pass energies for this device.

  • energy_source –

    Device that can give us the correct excitation energy and switch sources if applicable.

    (in eV).

  • name (str, default: '') – Name of the device.

Methods

set(epics_region)

Move a group of signals defined in a region.

Attributes

acquire_time

acquire_period

num_images

image_mode

detector_state

unique_id

nd_attributes_file

acquire

array_size_x

array_size_y

data_type

array_counter

wait_for_plugins

abstract set(epics_region: TAbstractBaseRegion)[source]#

Move a group of signals defined in a region. Each implementation of this class is responsible for implementing this method correctly.

Parameters:

  • region – Contains the parameters to setup the driver for a scan.

  • epics_region (TypeVar(TAbstractBaseRegion, bound= AbstractBaseRegion))