Update readme for local triangulation

nmwsharp · Sep 27, 2022 · 5470f71 · 5470f71
1 parent adb76f1
commit 5470f71
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ python -m pip install potpourri3d --no-binary potpourri3d
 - [Mesh Vector Heat](#mesh-vector-heat)
 - [Mesh Geodesic Paths](#mesh-geodesic-paths)
 - [Point Cloud Distance & Vector Heat](#point-cloud-distance--vector-heat)
+- [Other Point Cloud Routines](#other-point-cloud-routines)
 
 ### Input / Output
 
@@ -201,3 +202,12 @@ logmap = solver.compute_log_map(sourceP)
   - `p_ind` index of the source point
 
 
+
+### Other Point Cloud Routines
+
+#### Local Triangulation
+
+Construct a _local triangulation_ of a point cloud, a surface-like set of triangles amongst the points in the cloud. This is _not_ a nice connected/watertight mesh, instead it is a crazy soup, which is a union of sets of triangles computed independently around each point. These triangles _are_ suitable for running many geometric algorithms on, such as approximating surface properties of the point cloud, or evaluating physical and geometric energies, or building Laplace matrices.
+
+- `PointCloudLocalTriangulation(P, with_degeneracy_heuristic=True)`
+  - `PointCloudLocalTriangulation.get_local_triangulation()` returns a `[V,M,3]` integer numpy array, holding indices of vertices which form the triangulation. Each `[i,:,:]` holds the local triangles about vertex `i`. `M` is the max number of neighbors in any local triangulation. For vertices with fewer neighbors, the trailing rows hold `-1`.