EdgeMender: A Topology Repair Algorithm for Voxel Boundary Meshes

Coverage Report

File	Stmts	Miss	Branch	BrPart	Cover	Missing
edge_mender
init.py	2	0	0	0	100%
data_factory.py	135	0	0	0	100%
edge_mender.py	160	0	38	0	100%
geometry_helper.py	43	0	8	0	100%
mesh_generator.py	74	0	12	0	100%
visualizer.py	46	0	22	0	100%
TOTAL	460	0	80	0	100%

This tool repairs non-manifold edges in voxel boundary meshes to fix downstream operations such as smoothing. Non-manifold edges are defined as edges shared by four faces. Voxel boundary meshes are 3D surface representations of a data set where the faces and vertices perfectly snap to cells in a structured voxel grid. Common uses for this algorithm are repairing output from Cuberille, Surface Nets before smoothing, and non-adaptive Dual Contouring implementation without vertex adjustment. The algorithm procedure works for quad meshes, but this implementation is currently limited to triangular meshes (see #3). This algorithm requires input meshes to have proper and consistent winding order. The algorithm procedure works for quad meshes, but this implementation is currently limited to triangular meshes (see #3). This algorithm requires input meshes to have proper and consistent winding order. The three algorithms listed above are provided in the mesh_generator module. A set of test data sets are provided in the data_factory module. A visualization tool is also provided in the visualizer module. The results folder contains the evaluation notebook while the example notebook quickly demonstrates the tool in use.

Getting Started

Install the package running:

pip install edge-mender

Then you can use the library like this:

from edge_mender import EdgeMender

mesh: trimesh.Trimesh = ...

mender = EdgeMender(mesh)
mender.repair()

For a walkthrough example, see the example notebook.

Contributing

Please see CONTRIBUTING.md

License

This project is licensed under the MIT license. Feel free to edit and distribute this template as you like.

See LICENSE for more information.