Note

Ophyd async is included on a provisional basis until the v1.0 release and may change API on minor release numbers before then

ophyd_async.core.DetectorGroupLogic#

class ophyd_async.core.DetectorGroupLogic[source]#

Bases: ABC

Methods

close

Close all writers and wait for them to be closed

collect_asset_docs

Collect asset docs from all writers

disarm

Disarm detectors

ensure_armed

Ensure the detectors are armed, return AsyncStatus that waits for disarm.

hints

Produce hints specifying which dataset(s) are most important

open

Open all writers, wait for them to be open and return their descriptors

wait_for_index

Wait until a specific index is ready to be collected

abstract async open() Dict[str, DataKey][source]#

Open all writers, wait for them to be open and return their descriptors

abstract async ensure_armed(trigger_info: TriggerInfo)[source]#

Ensure the detectors are armed, return AsyncStatus that waits for disarm.

abstract collect_asset_docs() AsyncIterator[Tuple[Literal['resource'], PartialResource] | Tuple[Literal['datum'], Datum] | Tuple[Literal['stream_resource'], StreamResource] | Tuple[Literal['stream_datum'], StreamDatum]][source]#

Collect asset docs from all writers

abstract async wait_for_index(index: int, timeout: float | None = 10.0)[source]#

Wait until a specific index is ready to be collected

abstract async disarm()[source]#

Disarm detectors

abstract async close()[source]#

Close all writers and wait for them to be closed

abstract hints() Hints[source]#

Produce hints specifying which dataset(s) are most important