PyMeshTool Documentation

Citation

Matthias A.F. Gsell, Benedikt A. Klöckl, Aurel Neic, Benedikt Mautner, Christoph M. Augustin, Elena Zappon, Gernot Plank, PyMeshTool — A framework for building efficient automated image-based cardiac anatomical twinning workflows in Python, Computer Methods and Programs in Biomedicine, Volume 285, 2026, 109476, ISSN 0169-2607, https://doi.org/10.1016/j.cmpb.2026.109476. (https://www.sciencedirect.com/science/article/pii/S0169260726002300)

Installation

PyMeshTool is a Python module that provides bindings to MeshTool. PyMeshTool implements interfaces to the mesh and image structures from MeshTool through the Mesh and Image class. Each class also provides interfaces to the MeshTool modes implemented as class methods. The PyPI package can be downloaded or installed from the PyPi server or by running

pip install pymeshtool

in your terminal. Run

pip install --upgrade pymeshtool

to upgrade an existing installation.

API Reference:

• pymeshtool
  • create_image()
  • create_mesh()
  • get_max_par_threads()
  • get_meshtool_git_info()
  • get_num_par_threads()
  • load_fibers()
  • load_points()
  • load_vtx()
  • save_fibers()
  • save_points()
  • save_vtx()
  • set_num_par_threads()
  • Mesh
    • Mesh.element_tags
    • Mesh.elements
    • Mesh.fibers
    • Mesh.num_elements
    • Mesh.num_fibers
    • Mesh.num_points
    • Mesh.points
    • Mesh.__deepcopy__()
    • Mesh.__getitem__()
    • Mesh.__init__()
    • Mesh.__len__()
    • Mesh.apply_split()
    • Mesh.clean_topology()
    • Mesh.clear_full_connectivity()
    • Mesh.compute_full_connectivity()
    • Mesh.connected_vtx_components()
    • Mesh.correspondence()
    • Mesh.extract_element_nodes()
    • Mesh.extract_elements()
    • Mesh.extract_gradient()
    • Mesh.extract_mesh()
    • Mesh.extract_myocard()
    • Mesh.extract_surface()
    • Mesh.extract_unreachable()
    • Mesh.extract_vtx()
    • Mesh.extract_vtxhalo()
    • Mesh.generate_distancefield()
    • Mesh.generate_fibers()
    • Mesh.generate_split()
    • Mesh.get_element_sizes()
    • Mesh.get_elements_in_selection()
    • Mesh.has_full_connectivity()
    • Mesh.interpolate_clouddata()
    • Mesh.interpolate_elem2node()
    • Mesh.interpolate_node2elem()
    • Mesh.interpolate_nodes()
    • Mesh.is_surface_mesh()
    • Mesh.merge()
    • Mesh.query_bbox()
    • Mesh.query_curvature()
    • Mesh.query_edges()
    • Mesh.query_idx()
    • Mesh.query_idxlist()
    • Mesh.query_quality()
    • Mesh.query_tags()
    • Mesh.refine_uniformly()
    • Mesh.rotate()
    • Mesh.save()
    • Mesh.scale()
    • Mesh.smooth_mesh()
    • Mesh.translate()
  • Mapping
    • Mapping.element_map
    • Mapping.mesh
    • Mapping.node_map
    • Mapping.submesh
    • Mapping.__matmul__()
    • Mapping.insert_back()
    • Mapping.insert_data()
    • Mapping.map_selection()
    • Mapping.prolongate()
    • Mapping.restrict()
    • Mapping.save()
  • Image
    • Image.data_type
    • Image.dtype
    • Image.origin
    • Image.shape
    • Image.voxel_size
    • Image.voxels
    • Image.__deepcopy__()
    • Image.__init__()
    • Image.change_type()
    • Image.crop()
    • Image.extract_mesh()
    • Image.extrude()
    • Image.resample()
    • Image.save()
  • PyMeshToolError
  • MeshInputFormat
  • MeshOutputFormat
  • MeshElementType
  • MeshClouddataInterpolationMode
  • MeshExtractUnreachableMode
  • ImageDType
  • ImageExtrusionMode

Examples:

• Benchmark

Other:

• Index
• Changes
• About