edge-mender 0.1.0

A Topology Repair Algorithm for Voxel Boundary Meshes

EdgeMender: A Topology Repair Algorithm for Voxel Boundary Meshes

Coverage Report

File	Stmts	Miss	Cover	Missing
edge_mender
init.py	2	0	100%
data_factory.py	135	0	100%
edge_mender.py	172	0	100%
geometry_helper.py	43	0	100%
mesh_generator.py	74	0	100%
visualizer.py	46	0	100%
TOTAL	472	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 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 and the example notebook demonstrates the tool in use.

Usage Instructions

pip install git+https://github.com/MattTheCuber/edge-mender

from edge_mender import EdgeMender

mesh: trimesh.Trimesh = ...

mender = EdgeMender(mesh)
mender.repair()

For a walkthrough example, see the example notebook.

Contributor Instructions

1. Clone the repository using git clone https://github.com/MattTheCuber/edge-mender.git
2. Initialize the submodule using git submodule update --init
3. Install uv
4. Create a virtual environment using uv venv
5. Install all development dependencies using uv sync --all-extras
6. Run pre-commit install
7. Create a branch and start writing code!