k-Wave Armature

class coperniFUS.modules.armatures.kwave_armatures.KwaveAShomogeneousSimulationArmature(armature_display_name, parent_viewer, stereotax_frame_instance, **kwargs)[source]

Bases: Armature

kWave simulation attributes are contained in kwAS

run_AS_simulation()[source]

Call to run kwave simulation

property axisym_domain_mesh

Mesh object of the domain boundaries

add_render()[source]

Called when populating the viewer with the armature rendered objects

update_render(force_update=False)[source]

Called on render view updates

delete_render()[source]

Called on deletion of the armature rendered objects

custom_armature_param_widgets(armature_params_rowcount, armature_params_colcount)[source]

List of widgets to be added in the Armature Parameters section of the Stereotaxic Frame Module dock.

class coperniFUS.modules.armatures.kwave_armatures.KWave3dSimulationArmature(armature_display_name, parent_viewer, stereotax_frame_instance, **kwargs)[source]

Bases: STLMeshBooleanArmature

kWave simulation attributes are contained in kw3D

run_3D_simulation()[source]

Call to run kwave simulation. Results are contained in kw3D attribute.

render_voxelized_mesh_debug_preview(material_index=0)[source]
custom_armature_param_widgets(armature_params_rowcount, armature_params_colcount)[source]

List of widgets to be added in the Armature Parameters section of the Stereotaxic Frame Module dock.

class coperniFUS.modules.armatures.kwave_armatures.KWaveAS3dSimulationArmature(armature_display_name, parent_viewer, stereotax_frame_instance, **kwargs)[source]

Bases: STLMeshBooleanArmature

kWave simulation attributes are contained in kwAS and kw3D

run_AS_simulation()[source]

Call to run kwave simulation. Results are contained in kwAS attribute.

run_AS3D_simulation()[source]

Call to run coupled kwave simulations. Results are contained in kwAS and kw3D attributes.

render_voxelized_mesh_debug_preview(material_index=0)[source]

Render previews of the voxelized meshes used for material parameters map definitions (For debug purposes).

property axisym_domain_mesh

Mesh object of the domain boundaries

add_render()[source]

Called when populating the viewer with the armature rendered objects

update_render(force_update=False)[source]

Called on render view updates

delete_render()[source]

Called on deletion of the armature rendered objects

custom_armature_param_widgets(armature_params_rowcount, armature_params_colcount)[source]

List of widgets to be added in the Armature Parameters section of the Stereotaxic Frame Module dock.