Skip to content

data_retrieval_asapo

Data retrieval from ASAP::O.

This module contains Data Retrieval classes that deal with the ASAP::O software framework (used at the PETRA III facility).

EigerAsapoDataRetrieval

Bases: OmDataRetrievalProtocol

See documentation of the __init__ function.

__init__(*, monitor_parameters, source)

Data retrieval for Eiger 16M from ASAP::O at the PETRA III facility.

This class implements OM's Data Retrieval Layer for an Eiger 16M detector using the ASAP::O software framework.

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

  • This class considers an individual data event as equivalent to the content of an ASAP::O event, which stores data related to a single detector frame.

  • The ASAP::O stream name and the ID of the ASAP::O event within the stream, combined into a single string, are used as event identifier.

  • ASAP::O provides timestamp, beam energy and detector distance information for each event.

  • The source string required by this Data Retrieval class 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:

Name Type Description Default
monitor_parameters MonitorParameters

An object storing OM's configuration parameters.

 required
source str

A string describing the data event source.

 required

get_data_event_handler()

Retrieves the Data Event Handler used by the Data Retrieval class.

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

Returns:

Type Description
OmDataEventHandlerProtocol

The Data Event Handler used by the Data Retrieval class.