`ophyd_async.epics.adcore`#

Core components of the areaDetector software.

https://github.com/areaDetector/ADCore

Package Contents#

Classes#

`ADBaseIO`	Base class from which areaDetector drivers are derived.
`ADCallbacks`	All members should exist in the Backend, and there will be no extras.
`ADCompression`	All members should exist in the Backend, and there will be no extras.
`ADBaseContAcqController`	Continuous acquisition interface for an AreaDetector.
`AreaDetector`	Detector base class for step and fly scanning detectors.
`ADState`	Default set of states of an AreaDetector driver.
`ContAcqAreaDetector`	Ophyd-async implementation of a continuously acquiring AreaDetector.
`NDArrayBaseIO`	Class responsible for passing detector data from drivers to pluglins.
`NDFileIO`	Base class from which file plugins are derived.
`NDFileHDFIO`	Plugin for storing data in HDF5 file format.
`NDPluginBaseIO`	Base class from which plugins are derived.
`NDPluginStatsIO`	Plugin for computing statistics from an image or ROI within an image.
`ADBaseDatasetDescriber`	For describing datasets in file writing.
`ADBaseController`	Detector logic for arming and disarming the detector.
`ADWriter`	Common behavior for all areaDetector writers.
`ADHDFWriter`	Allow `NDFileHDFIO` to be used within `StandardDetector`.
`ADTIFFWriter`	Common behavior for all areaDetector writers.
`ADJPEGWriter`	Common behavior for all areaDetector writers.
`SingleTriggerDetector`	Device that provides selected child Device values in `read()`.
`ADBaseDataType`	All members should exist in the Backend, and there will be no extras.
`ADFileWriteMode`	All members should exist in the Backend, and there will be no extras.
`ADImageMode`	All members should exist in the Backend, but there may be extras.
`NDAttributePv`
`NDAttributeParam`
`NDAttributeDataType`	All members should exist in the Backend, and there will be no extras.
`NDAttributePvDbrType`	All members should exist in the Backend, and there will be no extras.
`NDCBFlushOnSoftTrgMode`	All members should exist in the Backend, and there will be no extras.
`NDPluginCBIO`	Base class from which plugins are derived.

Functions#

stop_busy_record

Data#

DEFAULT_GOOD_STATES

API#

class ophyd_async.epics.adcore.ADBaseIO(prefix: str, with_pvi: bool = False, name: str = '')[source]#

Bases: ophyd_async.epics.adcore._core_io.NDArrayBaseIO

Base class from which areaDetector drivers are derived.

This mirrors the interface provided by ADCore/db/ADBase.template. See HTML docs at https://areadetector.github.io/areaDetector/ADCore/ADDriver.html

acquire_time: Annotated[SignalRW[float], ophyd_async.epics.core.PvSuffix.rbv('AcquireTime')]#: None

acquire_period: Annotated[SignalRW[float], ophyd_async.epics.core.PvSuffix.rbv('AcquirePeriod')]#: None

num_images: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('NumImages')]#: None

image_mode: Annotated[SignalRW[ADImageMode], ophyd_async.epics.core.PvSuffix.rbv('ImageMode')]#: None

detector_state: Annotated[SignalR[ADState], PvSuffix('DetectorState_RBV')]#: None

class ophyd_async.epics.adcore.ADCallbacks[source]#

Bases: ophyd_async.core.StrictEnum

All members should exist in the Backend, and there will be no extras.

ENABLE#: ‘Enable’

DISABLE#: ‘Disable’

class ophyd_async.epics.adcore.ADCompression[source]#

Bases: ophyd_async.core.StrictEnum

All members should exist in the Backend, and there will be no extras.

NONE#: ‘None’

NBIT#: ‘N-bit’

SZIP#: ‘szip’

ZLIB#: ‘zlib’

BLOSC#: ‘Blosc’

BSLZ4#: ‘BSLZ4’

LZ4#: ‘LZ4’

JPEG#: ‘JPEG’

class ophyd_async.epics.adcore.ADBaseContAcqController(driver: ADBaseIO, cb_plugin: NDPluginCBIO)[source]#

Bases: ophyd_async.epics.adcore._core_logic.ADBaseController[ophyd_async.epics.adcore._core_io.ADBaseIO]

Continuous acquisition interface for an AreaDetector.

get_deadtime(exposure)[source]#: For a given exposure, how long should the time between exposures be.

async ensure_acquisition_settings_valid(trigger_info: TriggerInfo) → None[source]#: Ensure the trigger mode is valid for the detector.

async ensure_in_continuous_acquisition_mode() → None[source]#: Ensure the detector is in continuous acquisition mode.

async prepare(trigger_info: TriggerInfo) → None[source]#

Do all necessary steps to prepare the detector for triggers.

Parameters:: trigger_info – The sort of triggers to expect.

async arm() → None[source]#: Arm the detector.

async disarm() → None[source]#: Disarm the detector, return detector to an idle state.

class ophyd_async.epics.adcore.AreaDetector(controller: ADBaseControllerT, writer: ADWriter, plugins: dict[str, NDPluginBaseIO] | None = None, config_sigs: Sequence[SignalR] = (), name: str = '')[source]#

Bases: ophyd_async.core.StandardDetector[ophyd_async.epics.adcore._core_logic.ADBaseControllerT, ophyd_async.epics.adcore._core_writer.ADWriter]

Detector base class for step and fly scanning detectors.

Aggregates controller and writer logic together.

Parameters:

controller – Logic for arming and disarming the detector
writer – Logic for making the detector write persistent data
config_sigs – Signals to read when describe and read configuration are called
name – Device name

get_plugin(name: str, plugin_type: type[NDPluginBaseIO] = NDPluginBaseIO) → NDPluginBaseIO[source]#

class ophyd_async.epics.adcore.ADState[source]#

Bases: ophyd_async.core.StrictEnum

Default set of states of an AreaDetector driver.

See definition in ADApp/ADSrc/ADDriver.h in https://github.com/areaDetector/ADCore.

IDLE#: ‘Idle’

ACQUIRE#: ‘Acquire’

READOUT#: ‘Readout’

CORRECT#: ‘Correct’

SAVING#: ‘Saving’

ABORTING#: ‘Aborting’

ERROR#: ‘Error’

WAITING#: ‘Waiting’

INITIALIZING#: ‘Initializing’

DISCONNECTED#: ‘Disconnected’

ABORTED#: ‘Aborted’

class ophyd_async.epics.adcore.ContAcqAreaDetector(prefix: str, path_provider: PathProvider, drv_cls: type[ADBaseIO] = ADBaseIO, drv_suffix: str = 'cam1:', cb_suffix: str = 'CB1:', writer_cls: type[ADWriter] = ADHDFWriter, fileio_suffix: str | None = None, name: str = '', plugins: dict[str, NDPluginBaseIO] | None = None, config_sigs: Sequence[SignalR] = ())[source]#

Bases: ophyd_async.epics.adcore._core_detector.AreaDetector[ophyd_async.epics.adcore._core_logic.ADBaseContAcqController]

Ophyd-async implementation of a continuously acquiring AreaDetector.

class ophyd_async.epics.adcore.NDArrayBaseIO(prefix: str, with_pvi: bool = False, name: str = '')[source]#

Bases: ophyd_async.epics.core.EpicsDevice

Class responsible for passing detector data from drivers to pluglins.

This mirrors the interface provided by ADCore/db/NDArrayBase.template. See HTML docs at https://areadetector.github.io/areaDetector/ADCore/NDArray.html

unique_id: Annotated[SignalR[int], PvSuffix('UniqueId_RBV')]#: None

nd_attributes_file: Annotated[SignalRW[str], PvSuffix('NDAttributesFile')]#: None

acquire: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('Acquire')]#: None

array_size_x: Annotated[SignalR[int], PvSuffix('ArraySizeX_RBV')]#: None

array_size_y: Annotated[SignalR[int], PvSuffix('ArraySizeY_RBV')]#: None

data_type: Annotated[SignalR[ADBaseDataType], PvSuffix('DataType_RBV')]#: None

array_counter: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('ArrayCounter')]#: None

wait_for_plugins: Annotated[SignalRW[bool], PvSuffix('WaitForPlugins')]#: None

class ophyd_async.epics.adcore.NDFileIO(prefix: str, with_pvi: bool = False, name: str = '')[source]#

Bases: ophyd_async.epics.adcore._core_io.NDPluginBaseIO

Base class from which file plugins are derived.

This mirrors the interface provided by ADCore/db/NDFile.template. See HTML docs at https://areadetector.github.io/areaDetector/ADCore/NDPluginFile.html

file_path: Annotated[SignalRW[str], ophyd_async.epics.core.PvSuffix.rbv('FilePath')]#: None

file_name: Annotated[SignalRW[str], ophyd_async.epics.core.PvSuffix.rbv('FileName')]#: None

file_path_exists: Annotated[SignalR[bool], PvSuffix('FilePathExists_RBV')]#: None

file_template: Annotated[SignalRW[str], ophyd_async.epics.core.PvSuffix.rbv('FileTemplate')]#: None

full_file_name: Annotated[SignalR[str], PvSuffix('FullFileName_RBV')]#: None

file_number: Annotated[SignalRW[int], PvSuffix('FileNumber')]#: None

auto_increment: Annotated[SignalRW[bool], PvSuffix('AutoIncrement')]#: None

file_write_mode: Annotated[SignalRW[ADFileWriteMode], ophyd_async.epics.core.PvSuffix.rbv('FileWriteMode')]#: None

num_capture: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('NumCapture')]#: None

num_captured: Annotated[SignalR[int], PvSuffix('NumCaptured_RBV')]#: None

capture: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('Capture')]#: None

array_size0: Annotated[SignalR[int], PvSuffix('ArraySize0')]#: None

array_size1: Annotated[SignalR[int], PvSuffix('ArraySize1')]#: None

create_directory: Annotated[SignalRW[int], PvSuffix('CreateDirectory')]#: None

class ophyd_async.epics.adcore.NDFileHDFIO(prefix: str, with_pvi: bool = False, name: str = '')[source]#

Bases: ophyd_async.epics.adcore._core_io.NDFileIO

Plugin for storing data in HDF5 file format.

This mirrors the interface provided by ADCore/db/NDFileHDF5.template. See HTML docs at https://areadetector.github.io/areaDetector/ADCore/NDFileHDF5.html

position_mode: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('PositionMode')]#: None

compression: Annotated[SignalRW[ADCompression], ophyd_async.epics.core.PvSuffix.rbv('Compression')]#: None

num_extra_dims: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('NumExtraDims')]#: None

swmr_mode: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('SWMRMode')]#: None

flush_now: Annotated[SignalRW[bool], PvSuffix('FlushNow')]#: None

xml_file_name: Annotated[SignalRW[str], ophyd_async.epics.core.PvSuffix.rbv('XMLFileName')]#: None

num_frames_chunks: Annotated[SignalR[int], PvSuffix('NumFramesChunks_RBV')]#: None

chunk_size_auto: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('ChunkSizeAuto')]#: None

lazy_open: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('LazyOpen')]#: None

class ophyd_async.epics.adcore.NDPluginBaseIO(prefix: str, with_pvi: bool = False, name: str = '')[source]#

Bases: ophyd_async.epics.adcore._core_io.NDArrayBaseIO

Base class from which plugins are derived.

This mirrors the interface provided by ADCore/db/NDPluginBase.template. See HTML docs at https://areadetector.github.io/areaDetector/ADCore/NDPluginDriver.html

nd_array_port: Annotated[SignalRW[str], ophyd_async.epics.core.PvSuffix.rbv('NDArrayPort')]#: None

enable_callbacks: Annotated[SignalRW[ADCallbacks], ophyd_async.epics.core.PvSuffix.rbv('EnableCallbacks')]#: None

nd_array_address: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('NDArrayAddress')]#: None

array_size0: Annotated[SignalR[int], PvSuffix('ArraySize0_RBV')]#: None

array_size1: Annotated[SignalR[int], PvSuffix('ArraySize1_RBV')]#: None

queue_size: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('QueueSize')]#: None

class ophyd_async.epics.adcore.NDPluginStatsIO(prefix: str, with_pvi: bool = False, name: str = '')[source]#

Bases: ophyd_async.epics.adcore._core_io.NDPluginBaseIO

Plugin for computing statistics from an image or ROI within an image.

This mirrors the interface provided by ADCore/db/NDStats.template. See HTML docs at https://areadetector.github.io/areaDetector/ADCore/NDPluginStats.html

compute_statistics: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('ComputeStatistics')]#: None

bgd_width: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('BgdWidth')]#: None

total_array: Annotated[SignalRW[float], ophyd_async.epics.core.PvSuffix.rbv('TotalArray')]#: None

compute_centroid: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('ComputeCentroid')]#: None

centroid_threshold: Annotated[SignalRW[float], ophyd_async.epics.core.PvSuffix.rbv('CentroidThreshold')]#: None

compute_profiles: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('ComputeProfiles')]#: None

profile_size_x: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('ProfileSizeX')]#: None

profile_size_y: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('ProfileSizeY')]#: None

cursor_x: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('CursorX')]#: None

cursor_y: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('CursorY')]#: None

compute_histogram: Annotated[SignalRW[bool], ophyd_async.epics.core.PvSuffix.rbv('ComputeHistogram')]#: None

hist_size: Annotated[SignalRW[int], ophyd_async.epics.core.PvSuffix.rbv('HistSize')]#: None

hist_min: Annotated[SignalRW[float], ophyd_async.epics.core.PvSuffix.rbv('HistMin')]#: None

hist_max: Annotated[SignalRW[float], ophyd_async.epics.core.PvSuffix.rbv('HistMax')]#: None

ophyd_async.epics.adcore.DEFAULT_GOOD_STATES: frozenset[ADState]#: ‘frozenset(…)’

class ophyd_async.epics.adcore.ADBaseDatasetDescriber(driver: NDArrayBaseIO)[source]#

Bases: ophyd_async.core.DatasetDescriber

For describing datasets in file writing.

async np_datatype() → str[source]#: Return the numpy datatype for this dataset.

async shape() → tuple[int, int][source]#: Get the shape of the data collection.

class ophyd_async.epics.adcore.ADBaseController(driver: ADBaseIOT, good_states: frozenset[ADState] = DEFAULT_GOOD_STATES)[source]#

Bases: ophyd_async.core.DetectorController, typing.Generic[ophyd_async.epics.adcore._core_logic.ADBaseIOT]

Detector logic for arming and disarming the detector.

async prepare(trigger_info: TriggerInfo) → None[source]#

Do all necessary steps to prepare the detector for triggers.

Parameters:: trigger_info – The sort of triggers to expect.

async arm()[source]#: Arm the detector.

async wait_for_idle()[source]#: Wait on the internal _arm_status and wait for it to get disarmed/idle.

async disarm()[source]#: Disarm the detector, return detector to an idle state.

async set_exposure_time_and_acquire_period_if_supplied(exposure: float | None = None, timeout: float = DEFAULT_TIMEOUT) → None[source]#

Set the exposure time and acquire period.

If exposure is not None, this sets the acquire time to the exposure time and sets the acquire period to the exposure time plus the deadtime. This is expected behavior for most AreaDetectors, but some may require more specialized handling.

Parameters:: exposure (How long to wait for the exposure time and acquire period to be set.) – Desired exposure time, this is a noop if it is None.

async start_acquiring_driver_and_ensure_status() → AsyncStatus[source]#

Start acquiring driver, raising ValueError if the detector is in a bad state.

This sets driver.acquire to True, and waits for it to be True up to a timeout. Then, it checks that the DetectorState PV is in DEFAULT_GOOD_STATES, and otherwise raises a ValueError.

Returns AsyncStatus:: An AsyncStatus that can be awaited to set driver.acquire to True and perform subsequent raising (if applicable) due to detector state.

class ophyd_async.epics.adcore.ADWriter(fileio: NDFileIOT, path_provider: PathProvider, name_provider: NameProvider, dataset_describer: DatasetDescriber, file_extension: str = '', mimetype: str = '', plugins: dict[str, NDPluginBaseIO] | None = None)[source]#

Bases: ophyd_async.core._detector.DetectorWriter, typing.Generic[ophyd_async.epics.adcore._core_writer.NDFileIOT]

Common behavior for all areaDetector writers.

default_suffix: str#: ‘FILE1:’

classmethod with_io(prefix: str, path_provider: PathProvider, dataset_source: NDArrayBaseIO | None = None, fileio_suffix: str | None = None, plugins: dict[str, NDPluginBaseIO] | None = None) → ADWriterT[source]#

async begin_capture() → None[source]#

async open(multiplier: int = 1) → dict[str, DataKey][source]#

Open writer and wait for it to be ready for data.

Parameters:: multiplier – Each StreamDatum index corresponds to this many written exposures
Returns:: Output for describe()

async observe_indices_written(timeout: float) → AsyncGenerator[int, None][source]#: Wait until a specific index is ready to be collected.

async get_indices_written() → int[source]#: Get the number of indices written.

async collect_stream_docs(indices_written: int) → AsyncIterator[StreamAsset][source]#

async close()[source]#: Close writer, blocks until I/O is complete.

property hints: Hints#: The hints to be used for the detector.

class ophyd_async.epics.adcore.ADHDFWriter(fileio: NDFileHDFIO, path_provider: PathProvider, name_provider: NameProvider, dataset_describer: DatasetDescriber, plugins: dict[str, NDPluginBaseIO] | None = None)[source]#

Bases: ophyd_async.epics.adcore._core_writer.ADWriter[ophyd_async.epics.adcore._core_io.NDFileHDFIO]

Allow NDFileHDFIO to be used within StandardDetector.

default_suffix: str#: ‘HDF1:’

async open(multiplier: int = 1) → dict[str, DataKey][source]#

Open writer and wait for it to be ready for data.

Parameters:: multiplier – Each StreamDatum index corresponds to this many written exposures
Returns:: Output for describe()

async collect_stream_docs(indices_written: int) → AsyncIterator[StreamAsset][source]#

class ophyd_async.epics.adcore.ADTIFFWriter(fileio: NDFileIO, path_provider: PathProvider, name_provider: NameProvider, dataset_describer: DatasetDescriber, plugins: dict[str, NDPluginBaseIO] | None = None)[source]#

Bases: ophyd_async.epics.adcore._core_writer.ADWriter[ophyd_async.epics.adcore._core_io.NDFileIO]

Common behavior for all areaDetector writers.

default_suffix: str#: ‘TIFF1:’

class ophyd_async.epics.adcore.ADJPEGWriter(fileio: NDFileIO, path_provider: PathProvider, name_provider: NameProvider, dataset_describer: DatasetDescriber, plugins: dict[str, NDPluginBaseIO] | None = None)[source]#

Bases: ophyd_async.epics.adcore._core_writer.ADWriter[ophyd_async.epics.adcore._core_io.NDFileIO]

Common behavior for all areaDetector writers.

default_suffix: str#: ‘JPEG1:’

class ophyd_async.epics.adcore.SingleTriggerDetector(drv: ADBaseIO, read_uncached: Sequence[SignalR] = (), name='', plugins: dict[str, NDPluginBaseIO] | None = None)[source]#

Bases: ophyd_async.core.StandardReadable, bluesky.protocols.Triggerable

Device that provides selected child Device values in read().

Provides the ability for children to be registered to:

Participate in stage() and unstage()
Provide their value in read() and `describe()
Provide their value in read_configuration() and `describe_configuration()
Select a value to appear in hints

The behavior is customized with a StandardReadableFormat

async stage() → None[source]#

async trigger() → None[source]#

class ophyd_async.epics.adcore.ADBaseDataType[source]#

Bases: ophyd_async.core.StrictEnum

All members should exist in the Backend, and there will be no extras.

INT8#: ‘Int8’

UINT8#: ‘UInt8’

INT16#: ‘Int16’

UINT16#: ‘UInt16’

INT32#: ‘Int32’

UINT32#: ‘UInt32’

INT64#: ‘Int64’

UINT64#: ‘UInt64’

FLOAT32#: ‘Float32’

FLOAT64#: ‘Float64’

class ophyd_async.epics.adcore.ADFileWriteMode[source]#

Bases: ophyd_async.core.StrictEnum

All members should exist in the Backend, and there will be no extras.

SINGLE#: ‘Single’

CAPTURE#: ‘Capture’

STREAM#: ‘Stream’

class ophyd_async.epics.adcore.ADImageMode[source]#

Bases: ophyd_async.core.SubsetEnum

All members should exist in the Backend, but there may be extras.

SINGLE#: ‘Single’

MULTIPLE#: ‘Multiple’

CONTINUOUS#: ‘Continuous’

class ophyd_async.epics.adcore.NDAttributePv[source]#

name: str#: None

signal: SignalR#: None

dbrtype: NDAttributePvDbrType#: None

description: str = <Multiline-String>#

class ophyd_async.epics.adcore.NDAttributeParam[source]#

name: str#: None

param: str#: None

datatype: NDAttributeDataType#: None

addr: int#: 0

description: str = <Multiline-String>#

class ophyd_async.epics.adcore.NDAttributeDataType[source]#

Bases: ophyd_async.core.StrictEnum

All members should exist in the Backend, and there will be no extras.

INT#: ‘INT’

DOUBLE#: ‘DOUBLE’

STRING#: ‘STRING’

async ophyd_async.epics.adcore.stop_busy_record(signal: SignalRW[SignalDatatypeT], value: SignalDatatypeT, timeout: float = DEFAULT_TIMEOUT, status_timeout: float | None = None) → None[source]#

class ophyd_async.epics.adcore.NDAttributePvDbrType[source]#

Bases: ophyd_async.core.StrictEnum

All members should exist in the Backend, and there will be no extras.

DBR_SHORT#: ‘DBR_SHORT’

DBR_ENUM#: ‘DBR_ENUM’

DBR_INT#: ‘DBR_INT’

DBR_LONG#: ‘DBR_LONG’

DBR_FLOAT#: ‘DBR_FLOAT’

DBR_DOUBLE#: ‘DBR_DOUBLE’

DBR_STRING#: ‘DBR_STRING’

DBR_CHAR#: ‘DBR_CHAR’

class ophyd_async.epics.adcore.NDCBFlushOnSoftTrgMode[source]#

Bases: ophyd_async.core.StrictEnum

All members should exist in the Backend, and there will be no extras.

ON_NEW_IMAGE#: ‘OnNewImage’

IMMEDIATELY#: ‘Immediately’

class ophyd_async.epics.adcore.NDPluginCBIO(prefix: str, with_pvi: bool = False, name: str = '')[source]#

Bases: ophyd_async.epics.adcore._core_io.NDPluginBaseIO

Base class from which plugins are derived.

This mirrors the interface provided by ADCore/db/NDPluginBase.template. See HTML docs at https://areadetector.github.io/areaDetector/ADCore/NDPluginDriver.html