xes_gui
OM's GUI for x-ray emission spectroscopy.
This module contains a graphical interface that displays reduced and aggregated data in x-ray emission spectroscopy experiments.
XesGui
Bases: OmGuiBase
See documentation of the __init__ function.
__init__(url, time_resolved=False)
OM graphical user interface for XES.
This class implements a graphical user interface for XES experiments.
The GUI receives reduced and aggregated data from an OnDA Monitor, but only
when it is tagged with the view:omdata label. The data must contain
information about the collected XES spectra. The UI then displays the last
observed XES spectrum, both in raw and smoothed form, plus an average of the
most recently collected spectra. For time resolved experiments, this GUI
displays average spectra for pumped and dark events separately, and also shows
their difference.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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. |
required |
update_gui()
Updates the elements of the XES GUI.
This method overrides the corresponding method of the base class: please also refer to the documentation of that class for more information.
This method, which is called at regular intervals, updates the plots showing the spectrum information.
main(url, time_resolved)
OM Graphical User Interface for X-ray Emission Spectroscopy. This program must connect to a running OnDA Monitor for X-ray Emission Spectroscopy. If the monitor broadcasts the necessary information, this GUI displays the latest observed XES spectrum, both in raw and smoothed form, and an average of the most recently collected spectra. For time resolved experiments, the GUI displays separate average spectra for pumped and dark events, and also shows their difference.
The graphical interface connects to and OnDA Monitor running at the IP address (or hostname) + port 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": the GUI connects, using the tcp protocol, to a monitor running on the local machine at port 12321.
xes_gui.py
OM Graphical User Interface for X-ray Emission Spectroscopy. This program must connect to a running OnDA Monitor for X-ray Emission Spectroscopy. If the monitor broadcasts the necessary information, this GUI displays the latest observed XES spectrum, both in raw and smoothed form, and an average of the most recently collected spectra. For time resolved experiments, the GUI displays separate average spectra for pumped and dark events, and also shows their difference.
The graphical interface connects to and OnDA Monitor running at the IP address (or hostname) + port 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": the GUI connects, using the tcp protocol, to a monitor running on the local machine at port 12321.
Usage:
xes_gui.py [OPTIONS] [URL] [TIME_RESOLVED]
Options:
--help Show this message and exit.