data_retrieval_psana

Retrieval of data from psana.

This module contains Data Retrieval classes that deal with the psana software framework (used at the LCLS facility).

CxiLclsDataRetrieval

Bases: OmDataRetrievalProtocol

See documentation of the __init__ function.

__init__(*, monitor_parameters, source)

Data Retrieval from psana at the CXI beamline of the LCLS facility.

This class implements OM's Data Retrieval Layer for the CXI beamline of the LCLS facility, using the Jungfrau 4M x-ray detector. The Jungfrau 4M is currently the main detector used at the CXI beamline.

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 a psana event, which stores data related to a single detector frame.

• A string combining psana's timestamp and fiducial information, with the following format: {timestamp: seconds}-{timestamp: nanoseconds}-{fiducials}, is used as event identifier.

• Psana provides timestamp, beam energy and detector distance information for each event, retrieved from various sensors in the system.

• The source string required by this Data Retrieval class is a string of the type used by psana to identify specific runs, experiments, or live data streams.

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.

CxiLclsCspadDataRetrieval

Bases: OmDataRetrievalProtocol

See documentation of the __init__ function.

__init__(*, monitor_parameters, source)

Data Retrieval from psana at the CXI beamline of the LCLS facility (CSPAD).

This class implements OM's Data Retrieval Layer for the CXI beamline of the LCLS facility, using the CSPAD x-ray detector. This detector was used at the beamline until early 2020.

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 a psana event, which stores data related to a single detector frame.

• A string combining psana's timestamp and fiducial information, with the following format: {timestamp: seconds}-{timestamp: nanoseconds}-{fiducials}, is used as event identifier.

• Psana provides timestamp, beam energy and detector distance data for each event, retrieved from various sensors in the system.

• The source string required by this Data Retrieval class is a string of the type used by psana to identify specific runs, experiments, or live data streams.

Parameters:

Name	Type	Description	Default
monitor_parameters	MonitorParameters	An object 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.

LclsEpix100DataRetrieval

Bases: OmDataRetrievalProtocol

See documentation of the __init__ function.

__init__(*, monitor_parameters, source)

Data Retrieval from psana at the CXI beamline of the LCLS facility (ePix100).

This class implements OM's Data Retrieval Layer for the CXI beamline of the LCLS facility, using the ePix100 x-ray detector. This detector is often used to record beam energy spectrum information in X-ray Emission Spectroscopy experiments.

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 a psana event, which stores data related to a single detector frame.

• A string combining psana's timestamp and fiducial information, with the following format: {timestamp: seconds}-{timestamp: nanoseconds}-{fiducials}, is used as event identifier.

• Psana provides timestamp, beam energy and detector distance data for each event, retrieved from various sensors in the system.

• The source string required by this Data Retrieval class is a string of the type used by psana to identify specific runs, experiments, or live data streams.

Parameters:

Name	Type	Description	Default
monitor_parameters	MonitorParameters	An object storing OM's configuration	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.

MfxLclsDataRetrieval

Bases: OmDataRetrievalProtocol

See documentation of the __init__ function.

__init__(*, monitor_parameters, source)

Data Retrieval from psana at the MFX beamline of the LCLS facility.

This class implements OM's Data Retrieval Layer for the MFX beamline of the LCLS facility, using the Epix10KA 2M x-ray detector. The Epix10KA is currently the main detector used at the MFX beamline.

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 a psana event, which stores data related to a single detector frame.

• A string combining psana's timestamp and fiducial information, with the following format: {timestamp: seconds}-{timestamp: nanoseconds}-{fiducials}, is used as event identifier.

• Psana provides timestamp, beam energy and detector distance data for each event, retrieved from various sensors in the system.

• The source string required by this Data Retrieval class is a string of the type used by psana to identify specific runs, experiments, or live data streams.

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.

MfxLclsRayonixDataRetrieval

Bases: OmDataRetrievalProtocol

See documentation of the __init__ function.

__init__(*, monitor_parameters, source)

Data Retrieval from psana at MFX beamline of the LCLS facility (Rayonix).

This class implements OM's Data Retrieval Layer for the MFX beamline of the LCLS facility, using the Rayonix x-ray detector.

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 a psana event, which stores data related to a single detector frame.

• A string combining psana's timestamp and fiducial information, with the following format: {timestamp: seconds}-{timestamp: nanoseconds}-{fiducials}, is used as event identifier.

• Psana provides timestamp, beam energy and detector distance data for each event, retrieved from various sensors in the system.

• The source string required by this Data Retrieval class is a string of the type used by psana to identify specific runs, experiments, or live data streams.

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.