MainViewerWindow

class prism._gui.widgets.MainViewerWindow(pipeline_obj, *args, **kwargs)[source]

Defines the MainViewerWindow class for the Projection GUI.

This class provides the main window for the GUI and combines all other widgets; layouts; and elements together.

__init__(pipeline_obj, *args, **kwargs)[source]

Initialize an instance of the MainViewerWindow class.

Parameters:

pipeline_obj (Pipeline object) – Instance of the Pipeline class for which the GUI needs to be initialized.

Other Parameters:
 
  • args (positional arguments) – The positional arguments that must be passed to the constructor of the QMainWindow class.
  • kwargs (keyword arguments) – The keyword arguments that must be passed to the constructor of the QMainWindow class.
about()[source]

Displays a small section with information about the GUI.

This function acts as a Qt slot.

all_call_proj_attr(name, *args, **kwargs)[source]

Calls the requested Projection attribute name using the provided args and kwargs on all ranks.

all_set_proj_attr(name, value)[source]

Sets the requested Projection attribute name to value on all ranks.

api_reference()[source]

Opens the API reference documentation of the GUI in a webbrowser.

This function acts as a Qt slot.

call_proj_attr(name, *args, **kwargs)[source]

Calls the requested Projection attribute name using the provided args and kwargs on the controller rank.

closeEvent(*args, **kwargs)[source]

Special closeEvent() event that automatically performs some clean-up operations before the main window closes.

create_menubar()[source]

Creates the top-level menubar of the main window.

Other widgets can modify this menubar to add additional actions to it.

create_statusbar()[source]

Creates the bottom-level statusbar of the main window, primarily used for displaying extended descriptions of actions.

get_default_dock_positions()[source]

Returns the default positions of all dock widgets connected to the main window.

get_proj_attr(name)[source]

Gets the value of the requested Projection attribute name on the controller rank.

init()[source]

Sets up the main window after it has been initialized.

This function is mainly responsible for initializing all other widgets that are required to make the GUI work, and connecting them together.

set_default_dock_positions()[source]

Sets the positions of all dock widgets connected to the main window to their default positions.

This function acts as a Qt slot.

set_proj_attr(name, value)[source]

Sets the requested Projection attribute name to value on the controller rank.

show_pipeline_details_overview()[source]

Creates and shows a dialog containing the output of the details() method for all emulator iterations.

This function acts as a Qt slot.