dodal.plans.data_session_metadata

Functions

attach_data_session_metadata_decorator(plan)	Attach data session metadata to the runs within a plan and make it correlate with an ophyd-async DirectoryProvider.
attach_data_session_metadata_wrapper(plan[, ...])	Attach data session metadata to the runs within a plan and make it correlate with an ophyd-async DirectoryProvider.

dodal.plans.data_session_metadata.attach_data_session_metadata_wrapper(plan: Generator[Msg, Any, None], provider: UpdatingDirectoryProvider | None = None) → Generator[Msg, Any, None]

Attach data session metadata to the runs within a plan and make it correlate with an ophyd-async DirectoryProvider.

This updates the directory 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, None]) – The plan to preprocess

• provider (UpdatingDirectoryProvider | None, default: None) – The directory 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, None], provider: UpdatingDirectoryProvider | None = None) → Generator[Msg, Any, None]

Attach data session metadata to the runs within a plan and make it correlate with an ophyd-async DirectoryProvider.

This updates the directory 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, None]) – The plan to preprocess

• provider (UpdatingDirectoryProvider | None, default: None) – The directory provider that participating detectors are aware of.

Returns:

A plan

Return type:

MsgGenerator

Yields:

Iterator[Msg] – Plan messages