CoperniFUS Viewer

The Viewer hosts a PyQtGraph 3D viewport, and dockable areas for modules UIs.

class coperniFUS.viewer.Window(app, assets_dir_path='', disable_internal_console=False, disable_threaded_wrappers=False, **kwargs)

Bases: QMainWindow

Main class for CoperniFUS.

x_RED = '#e74c3c'

Defaut x axis color (red)

y_GREEN = '#7fd169'

Defaut y axis color (green)

z_BLUE = '#497ccc'

Defaut z axis color (blue)

ATLAS_SPACE_CONVENTION = ['Anterior', 'Left', 'Superior']

Atlas space convention defined according to the brainglobe-space

get_module_object_from_name(module_name=None)

Returns the module object handle associated to a module name. Call get_module_object_from_name() to get the list of all module names.

add_debug_trihedra(transform_matrix, axes_len=0.005, line_width=6)

Render an axes trihedra corresponding to a given transform_matrix with a fixed axes length (axes_len).

add_scale_accurate_debug_trihedra(transform_matrix, line_width=6)

Render an axes trihedra corresponding to a given transform_matrix. Axes length correspond to their actual scale.

delete_debug_trihedras()

Remove all debug trihedras

show_error_popup(error_title, error_description=None)

Error message handling wrapper method. Call to show an error popup window with a custom message.

load_example_configuration(example_configuration_name)

Switch to a configuration provided in CoperniFUS example directory

switch_cached_settings_file(cached_settings_fname, force_create_new=False)

Switch between cached configuration files available in cache directory or create new ones. The list of avalable configuration files can be assessed by calling cached_settings_files. Setting force_create_new to True will force the creation a a new config file by adding a suffix to cached_settings_fname if it already exists.

property cached_settings_files

Get the list of available cache configuration files in the cache directory

init_rendered_view()

Calls add_rendered_object for all loaded modules

update_rendered_view()

Calls update_rendered_object for all loaded modules

clear_rendered_view()

Calls delete_rendered_object for all loaded modules

hide_show_module_dock(module_dock, module_name, visibility)

Hide and show module docks

property slicing_plane_def

Slicing plane definition. Refer to slicing_plane_3pts and slicing_plane_normal_vect to get the plane location in other conventions.

property slicing_plane_3pts

Get the set of three points defining the location of the slicing plane

property slicing_plane_normal_vect

Get the normal vector defining the location of the slicing plane

update_theme()

Update CoperniFUS dark / light window theme.

event(event)

Handles app signals like system theme changes.

closeEvent(event)

Called when closing CoperniFUS.

coperniFUS.viewer.coperniFUSviewer(assets_dir_path=None, disable_internal_console=False, **kwargs)