dodal.devices.electron_analyser.ElectronAnalyserDetector#

class dodal.devices.electron_analyser.ElectronAnalyserDetector[source]#

Electron analyser detector with the additional functionality to load a sequence file and create a list of temporary ElectronAnalyserRegionDetector objects. These will setup configured region settings before data acquisition.

Parameters:

  • sequence_class (type[TypeVar(TAbstractBaseSequence, bound= AbstractBaseSequence)])

  • driver (TypeVar(TAbstractAnalyserDriverIO, bound= AbstractAnalyserDriverIO))

  • name (str, default: '')

Methods

create_region_detector_list(filename[, ...])

Create a list of detectors equal to the number of regions in a sequence file.

load_sequence(filename)

Load the sequence data from a provided json file into a sequence class.

stage()

Prepare the detector for use by ensuring it is idle and ready.

unstage()

Disarm the detector.

Attributes

driver

stage() → None[source]#

Prepare the detector for use by ensuring it is idle and ready.

This method asynchronously stages the detector by first disarming the controller to ensure the detector is not actively acquiring data, then invokes the driver’s stage procedure. This ensures the detector is in a known, ready state before use.

Raises:

Any exceptions raised by the driver's stage or controller's disarm methods. –

Return type:

None

unstage() → None[source]#

Disarm the detector.

Return type:

None

load_sequence(filename: str) → TAbstractBaseSequence[source]#

Load the sequence data from a provided json file into a sequence class.

Parameters:

filename (str) – Path to the sequence file containing the region data.

Return type:

TypeVar(TAbstractBaseSequence, bound= AbstractBaseSequence)

Returns:

Pydantic model representing the sequence file.

create_region_detector_list(filename: str, enabled_only=True) → list[ElectronAnalyserRegionDetector[TAbstractAnalyserDriverIO, TAbstractBaseRegion]][source]#

Create a list of detectors equal to the number of regions in a sequence file. Each detector is responsible for setting up a specific region.

Parameters:

  • filename (str) – Path to the sequence file containing the region data.

  • enabled_only (default: True) – If true, only include the region if enabled is True.

Return type:

list[ElectronAnalyserRegionDetector[TypeVar(TAbstractAnalyserDriverIO, bound= AbstractAnalyserDriverIO), TypeVar(TAbstractBaseRegion, bound= AbstractBaseRegion)]]

Returns:

List of ElectronAnalyserRegionDetector, equal to the number of regions in the sequence file.