dodal.plans.data_session_metadata#
Functions
Attach data session metadata to the runs within a plan and make it correlate with an ophyd-async PathProvider. |
|
|
Attach data session metadata to the runs within a plan and make it correlate with an ophyd-async PathProvider. |
- dodal.plans.data_session_metadata.attach_data_session_metadata_wrapper(plan: Generator[Msg, Any, P], provider: UpdatingPathProvider | None = None) Generator[Msg, Any, P] [source]#
Attach data session metadata to the runs within a plan and make it correlate with an ophyd-async PathProvider.
This updates the path provider (which in turn makes a call to to a service to figure out which scan number we are using for such a scan), and ensures the start document contains the correct data session.
- Parameters:
plan (
Generator
[Msg
,Any
,TypeVar
(P
)]) – The plan to preprocessprovider (
UpdatingPathProvider
|None
, default:None
) – The path provider that participating detectors are aware of.
- Returns:
A plan
- Return type:
MsgGenerator
- Yields:
Iterator[Msg] – Plan messages
- dodal.plans.data_session_metadata.attach_data_session_metadata_decorator(plan: Generator[Msg, Any, P], provider: UpdatingPathProvider | None = None) Generator[Msg, Any, P] #
Attach data session metadata to the runs within a plan and make it correlate with an ophyd-async PathProvider.
This updates the path provider (which in turn makes a call to to a service to figure out which scan number we are using for such a scan), and ensures the start document contains the correct data session.
- Parameters:
plan (
Generator
[Msg
,Any
,TypeVar
(P
)]) – The plan to preprocessprovider (
UpdatingPathProvider
|None
, default:None
) – The path provider that participating detectors are aware of.
- Returns:
A plan
- Return type:
MsgGenerator
- Yields:
Iterator[Msg] – Plan messages