Modules

Modules

Available Modules

• Anatomical landmarks calibration Module
• Tooltip Module
• Internal console Module
• Brain atlas Module
• Image as plane Module
• STL handler Module
• Stereotaxic Frame Module
  • Base Armature
  • Mesh Armature
  • k-Wave Armature

General Module class

class coperniFUS.modules.module_base.Module(parent_viewer, module_id, **kwargs)

Bases: object

Base class for CoperniFUS Modules

property module_id

Holds the module identifier for reference in get_module_object_from_name

get_user_param(param_name, default_value=None, additional_identifiers=[])

Cache wrapper for modules parameters Get parameters by their name using param_name. If the requested parameter is not found in the cache, default values provided in the static attribute _DEFAULT_PARAMS will be returned.

set_user_param(param_name, param_value, additional_identifiers=[])

init_dock()

Sets up a dock GUI for the module

add_rendered_object()

Called when adding module-specific elements to the 3D viewer

update_rendered_object()

Called for the update of module-specific elements already present in the 3D viewer

delete_rendered_object()

Called for the removal of module-specific elements from the 3D viewer