Projection GUI

Functions

prism._gui.start_gui(pipeline_obj)[source]

Creates an instance of QApplication or retrieves it if one already exists, and starts Crystal, PRISM’s Projection GUI.

Crystal provides an interactive way of creating projection figures, as opposed to the static and linear method provided by project(). It is made to make it easier to create; view; compare; and analyze large numbers of projection figures. All options available in the project() method can also be accessed through Crystal.

As with all Pipeline user methods, this function must be called by all MPI ranks.

New in version 1.2.0.

Parameters:pipeline_obj (Pipeline object) – The instance of the Pipeline class for which Crystal must be initialized.
Returns:main_window_obj (MainViewerWindow object) – The instance of the MainViewerWindow class that was created for drawing Crystal. Can be used for debugging purposes.

Note

This function can also be accessed through the crystal() method.