`crystallography_gui`

OM's GUI for Crystallography.

This module contains a graphical interface that displays reduced and aggregated data in Serial Crystallography experiments.

`CrystallographyGui`

Bases: OmGuiBase

See documentation of the __init__ function.

`init(*, url)`

OM graphical user interface for crystallography.

This class implements a graphical user interface for Serial Crystallography experiments. The GUI receives reduced and aggregated data from an OnDA Monitor, but only when it is tagged with the omdata label. The data must contain information about the position of detected Bragg peaks, and about the hit rate of the experiment. The GUI then displays a plot showing the evolution of the hit rate over time, a virtual powder pattern generated using the positions of the detected Bragg peaks, and a peakogram plot calculated from the Bragg peak information.

Parameters:

Name	Type	Description	Default
`url`	`str`	The URL at which the GUI should 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 Crystallography 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 hit rate history plot, the virtual powder pattern plot and the peakogram plot.

`main(*, url)`

OM Graphical User Interface for Crystallography. This program must connect to a running OnDA Monitor for Crystallography. If the monitor broadcasts the necessary information, this GUI displays the evolution of the hit rate over time, a real-time virtual powder pattern created using the positions of detected Bragg peaks, and a peakogram plot computed from the Bragg peak information.

The GUI 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.