updated docs

cheind · Sep 1, 2023 · c3a1d48 · c3a1d48
1 parent ff987db
commit c3a1d48
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,8 @@ See [examples/compare.py](examples/compare.py) for details and [doc/SDF.md](doc/
     -   Quad/Triangle topology support
     -   Vertex/Face normal support
 -   Tools for programmatically creating and modifying SDFs
--   Plotting support for reconstructed meshes using matplotlib
+-   Importing volumetric SDFs from NeRF tools such as [instant-ngp](https://www.google.com/search?channel=fs&client=ubuntu-sn&q=instant-ngp) and [NeuS2](https://github.com/19reborn/NeuS2)
+-   Inline plotting support for reconstructed meshes using matplotlib
 -   Exporting (STL) of tesselated isosurfaces
 
 ## Documentation
@@ -103,9 +104,34 @@ The examples can be found in [./examples/](./examples/). Each example can be inv
 python -m examples.<name>
 ```
 
-## Gallery
+### Mesh from NeRF
 
-Here are some additional plots from the library
+This library supports loading SDFs from density fields provided by various NeRF implementations (instant-ngp and NeuS2). These discretized SDF fields can then be manipulated/triangulated using **sdftoolbox** routines.
+
+The following image shows the resulting triangulated mesh from the Lego scene generated by **sdftoolbox** from an instant-ngp density image atlas.
+
+![](doc/nerf/naive25600.png)
+
+Command
+
+```shell
+python -m examples.nerf2mesh        \
+    -r 256 -t 4.0 -o -1.5 -s 0.0117 \
+    --sdf-flip                      \
+    doc/nerf/density.png
+```
+
+Note, meshes generated by **sdftoolbox** seem to be of better quality than those generated by the respective NeRF tools. The following compares a low-res reconstruction (res=64,drange=1) of the same scene
+
+|        sdftoolbox         |           NeuS2           |
+| :-----------------------: | :-----------------------: |
+| ![](doc/nerf/naive01.png) | ![](doc/nerf/neus200.png) |
+
+See https://github.com/19reborn/NeuS2/issues/22 for a discussion
+
+### Gallery
+
+Here are some additional plots from various examples
 
 <div align="center">
 <img src="doc/normals.gif" width="50%">

diff --git a/doc/nerf/density.png b/doc/nerf/density.png
diff --git a/doc/nerf/dual03.png b/doc/nerf/dual03.png
diff --git a/doc/nerf/midp02.png b/doc/nerf/midp02.png
diff --git a/doc/nerf/naive01.png b/doc/nerf/naive01.png
diff --git a/doc/nerf/naive25600.png b/doc/nerf/naive25600.png
diff --git a/doc/nerf/neus200.png b/doc/nerf/neus200.png
diff --git a/examples/density2mesh.py → examples/nerf2mesh.py b/examples/density2mesh.py → examples/nerf2mesh.py