data_event_handlers_asapo#

Handling of ASAP::O-based data events.

This module contains Data Event Handler classes that manipulate events originating from the ASAP::O software framework (used at the PETRA III facility).

class AsapoDataEventHandler(*, source, parameters)#

Data Event Handler for ASAP::O events.

This class handles data events retrieved from the ASAP::O software framework at the PETRA III facility.

This class implements the interface described by its base Protocol class. Please see the documentation of that class for additional information about the interface.

For this Event Handler, a data event corresponds to the content of an individual ASAP::O event.
The source string required by this Data Event Handler is either the ID of the beamtime for which OM is being used (for online data retrieval) or the ID of the beamtime and the name of the ASAP::O stream separated by a colon (for offline data retrieval).

Parameters:

source (str) – A string describing the data event source.
data_sources –
A dictionary containing a set of Data Source class instances.
- Each dictionary key must define the name of a data source.
- The corresponding dictionary value must store the instance of the OmDataSourceProtocol that describes the source.
parameters (DataRetrievalLayerParameters) – An object storing OM’s configuration parameters.

designated_collector_rank()#

Return type:: Literal[‘first’, ‘last’]

skip_rank_finalization()#

Return type:: bool

initialize_event_handling_on_collecting_node(*, node_rank, node_pool_size)#

Initializes ASAP::O event handling on the collecting node.

Please see the documentation of the base Protocol class for additional information about this method.

ASAP::O event handling does not need to be initialized on the collecting node, so this function actually does nothing.

Parameters:

node_rank (int) – The OM rank of the current node int the OM node pool. The rank is an integer that unambiguously identifies the node in the pool.
node_pool_size (int) – The total number of nodes in the OM pool, including all the processing nodes and the collecting node.

Return type:

None

initialize_event_handling_on_processing_node(*, node_rank, node_pool_size)#

Initializes ASAP::O event handling on the processing nodes.

Please see the documentation of the base Protocol class for additional information about this method.

Parameters:

node_rank (int) – The OM rank of the current node int the OM node pool. The rank is an integer that unambiguously identifies the node in the pool.
node_pool_size (int) – The total number of nodes in the OM pool, including all the processing nodes and the collecting node.

Return type:

None

event_generator(*, node_rank, node_pool_size)#

Retrieves ASAP::O events.

Please see the documentation of the base Protocol class for additional information about this method.

This function retrieves data events on the processing nodes. Each retrieved event corresponds to a single ASAP::O event.

Parameters:

node_rank (int) – The OM rank of the current node int the OM node pool. The rank is an integer that unambiguously identifies the node in the pool.
node_pool_size (int) – The total number of nodes in the OM pool, including all the processing nodes and the collecting node.

Return type:

Generator[dict[str, Any], None, None]

extract_data(*, event)#

Extracts data from an ASAP::O data event.

Please see the documentation of the base Protocol class for additional information about this method.

Parameters:

event (dict[str, Any]) – A dictionary storing the event data.

Returns:

A dictionary storing the extracted data.

Each dictionary key identifies a Data Source in the event for which data has been retrieved.

The corresponding dictionary value stores the data extracted from the Data Source for the event being processed.

Raises:

OmDataExtractionError – Raised when data cannot be extracted from the event.

Return type:

dict[str, Any]

initialize_event_data_retrieval()#

Initializes event data retrievals from ASAP::O.

This function initializes the retrieval of single standalone data events from ASAP::O.

Please see the documentation of the base Protocol class for additional information about this method.

Return type:: None

retrieve_event_data(event_id)#

Retrieves all data related to the requested event.

Please see the documentation of the base Protocol class for additional information about this method.

This function retrieves all data related to the event specified by the provided identifier. An ASAP::O event identifier corresponds to the ASAP::O stream name and the ID of the ASAP::O event within the stream, separated by the “//” symbol.

Parameters:: event_id (str) – A string that uniquely identifies a data event.
Returns:: All data related to the requested event.
Return type:: dict[str, Any]