Skip to content

frame_viewer

OM's Frame Viewer.

This module contains a graphical interface that displays detector data frames and, additional provided information.

FrameViewer

Bases: OmGuiBase

See documentation of the __init__ function.

__init__(*, url)

OM frame viewer.

This class implements a frame viewer. The viewer receives data from an OnDA Monitor, but only when it is tagged with the view:omframedata label. The data must contain calibrated detector data frames. The viewer then displays the received frames. If additional information is included in the received data (for example, the positions of detected Bragg peaks), the graphical interface shows it on each displayed frame image. A data storage buffer allows the viewer to stop receiving data from the OnDA Monitor, but still keep in memory the last 10 displayed frames for re-inspection.

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 Crystallography Frame Viewer.

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 displayed detector frame (and any additional shown information) using the most recently received data. Additionally, this function manages the data storage buffer that allows the last received detector frames to be re-inspected.

main(*, url)

OM Frame Viewer. This program must connect to a running OnDA Monitor. If the monitor broadcasts the necessary information, the program displays the most recently received detector data frame, and any additional related received data. The data stream from the monitor can also be temporarily paused, and any of 10 most recently displayed detector frames can be recalled for re-inspection.

The viewer 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 viewer connects, using the tcp protocol, to a monitor running on the local machine at port 12321.

crystallography_frame_viewer.py

OM Frame Viewer. This program must connect to a running OnDA Monitor. If the monitor broadcasts the necessary information, the program displays the most recently received detector data frame, and any additional related received data. The data stream from the monitor can also be temporarily paused, and any of 10 most recently displayed detector frames can be recalled for re-inspection.

The viewer 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 viewer connects, using the tcp protocol, to a monitor running on the local machine at port 12321.

Usage:

crystallography_frame_viewer.py [OPTIONS] [URL]

Options:

  --help  Show this message and exit.