Note

Ophyd async is considered experimental until the v1.0 release and may change API on minor release numbers before then

ophyd_async.plan_stubs#

Members

fly_and_collect

Kickoff, complete and collect with a flyer and multiple detectors.

prepare_static_seq_table_flyer_and_detectors_with_same_trigger

Prepare a hardware triggered flyable and one or more detectors.

time_resolved_fly_and_collect_with_static_seq_table

Run a scan wth a flyer and multiple detectors.

ensure_connected

setup_ndattributes

setup_ndstats_sum

ophyd_async.plan_stubs.fly_and_collect(stream_name: str, flyer: StandardFlyer[SeqTableInfo] | StandardFlyer[PcompInfo], detectors: list[StandardDetector])[source]#

Kickoff, complete and collect with a flyer and multiple detectors.

This stub takes a flyer and one or more detectors that have been prepared. It declares a stream for the detectors, then kicks off the detectors and the flyer. The detectors are collected until the flyer and detectors have completed.

ophyd_async.plan_stubs.prepare_static_seq_table_flyer_and_detectors_with_same_trigger(flyer: StandardFlyer[SeqTableInfo], detectors: list[StandardDetector], number_of_frames: int, exposure: float, shutter_time: float, repeats: int = 1, period: float = 0.0, frame_timeout: float | None = None)[source]#

Prepare a hardware triggered flyable and one or more detectors.

Prepare a hardware triggered flyable and one or more detectors with the same trigger. This method constructs TriggerInfo and a static sequence table from required parameters. The table is required to prepare the flyer, and the TriggerInfo is required to prepare the detector(s).

This prepares all supplied detectors with the same trigger.

ophyd_async.plan_stubs.time_resolved_fly_and_collect_with_static_seq_table(stream_name: str, flyer: StandardFlyer[SeqTableInfo], detectors: list[StandardDetector], number_of_frames: int, exposure: float, shutter_time: float, repeats: int = 1, period: float = 0.0, frame_timeout: float | None = None)[source]#

Run a scan wth a flyer and multiple detectors.

The stub demonstrates the standard basic flow for a flyscan:

  • Prepare the flyer and detectors with a trigger

  • Fly and collect:

    • Declare the stream and kickoff the scan

    • Collect while completing

This needs to be used in a plan that instantates detectors and a flyer, stages/unstages the devices, and opens and closes the run.