swaxs_gui

OM’s GUI for SWAXS.

This module contains the implementation of a graphical interface that displays reduced and aggregated data in SWAXS experiments.

class SwaxsGui(*, url)

OM graphical user interface for SWAXS.

This class implements a graphical user interface for SWAXS experiments. It is a subclass of the [OmGui] [om.graphical_interfaces.base.OmGui] base class.

This GUI receives reduced and aggregated data from an OnDA Monitor for SWAXS when it is tagged with the ‘omdata’ label. The data must contain information about peaks detected in the frames recently processed by the monitor and information about the current hit rate.

The GUI displays a plot showing the evolution of the hit rate over time, plus a virtual powder pattern created using the detected peaks.

Parameters:

url (str) – the URL at which the GUI will connect and listen for data. This must be a string in the format used by the ZeroMQ Protocol.

update_gui()

Updates the elements of the Swaxs GUI.

This method overrides the corresponding method of the base class: please also refer to the documentation of that class for more information.

This function stores the data received from OM, and calls the internal functions that update the hit rate history plot and the virtual power pattern.

Return type:

None

om_swaxs_gui

OM Graphical User Interface for SWAXS. This program must connect to a running OnDA Monitor for SWAXS. If the monitor broadcasts the necessary information, this GUI will display the evolution of the hit rate over time, plus a real-time virtual powder pattern created using the peaks detected in detector frames processed by the monitor.

The GUI connects to and OnDA Monitor running at the IP address (or hostname) specified by the URL string. This is a string in the format used by the ZeroMQ Protocol. The URL string is optional. If not provided, it defaults to “tcp://127.0.0.1:12321” and the viewer connects, using the tcp protocol, to a monitor running on the local machine at port 12321.

Usage

om_swaxs_gui [OPTIONS] [URL]

Arguments

URL

Optional argument

Experiment identifier