data_retrieval_zmq

Retrieval of data from a ZMQ stream.

This module contains Data Retrieval classes that deal with ZMQ data streams.

Jungfrau1MZmqDataRetrieval

Bases: OmDataRetrievalProtocol

See documentation of the __init__ function.

__init__(*, monitor_parameters, source)

Data Retrieval for Jungfrau 1M's ZMQ stream.

This class implements OM's Data Retrieval Layer for a Jungfrau 1M detector broadcasting data via a ZMQ stream.

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 corresponding to the content of a single ZMQ message sent by the Jungfrau 1M. Each message sent by the detector stores data related to a single detector data frame.

• The ZMQ stream provides detector data, timestamp and an event identifier for each event.

• Since Jungfrau 1M's ZMQ messages do not contain any detector distance or beam energy information, their values are retrieved from OM's configuration parameters (specifically, the fallback_detector_distance_in_mm and fallback_beam_energy_in_eV entries in the data_retrieval_layer parameter group).

• The source string required by this Data Retrieval class is the URL where the Jungfrau 1M detector broadcasts data.

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.