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
apply_panda_settings
apply_settings	Set every SignalRW to the given value in Settings.
apply_settings_if_different	Set every SignalRW in settings to its given value if it is different to the current value.
get_current_settings
retrieve_settings	Retrieve named Settings for a Device from a provider.
store_settings	Walk a Device for SignalRWs and store their values with a provider associated with the given name.

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

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)

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)

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.

ophyd_async.plan_stubs.apply_settings(settings: Settings) → Generator[Msg, Any, None]

Set every SignalRW to the given value in Settings. If value is None ignore it.

ophyd_async.plan_stubs.apply_settings_if_different(settings: Settings, apply_plan: Callable[[Settings], Generator[Msg, Any, None]], current_settings: Settings | None = None) → Generator[Msg, Any, None]

Set every SignalRW in settings to its given value if it is different to the current value.

Parameters:

• apply_plan – A device specific plan which takes the Settings to apply and applies them to the Device. Used to add device specific ordering to setting the signals.

• current_settings – If given, should be a superset of settings containing the current value of the Settings in the Device. If not given it will be created by reading just the signals given in settings.

ophyd_async.plan_stubs.retrieve_settings(provider: SettingsProvider, name: str, device: Device) → Generator[Msg, Any, Settings]

Retrieve named Settings for a Device from a provider.

ophyd_async.plan_stubs.store_settings(provider: SettingsProvider, name: str, device: Device) → Generator[Msg, Any, None]

Walk a Device for SignalRWs and store their values with a provider associated with the given name.