Update README.md, and increase library version.

Author: tatsy

CHANGELOG.md

@@ -1,6 +1,7 @@
-v.0.1.1
+v.0.2.0
 ---
 
+*   Add unit test for each functions (just to check run or not).
 *   Add feature preservation in remeshing.
 *   Include Eigen to repo as a submodule.
 *   Update Python setup to use Poetry.

README.md

@@ -33,19 +33,13 @@ Here is the list of modules and reference papers for that.
 Install
 ---
 
-### Dependency
-
 The module is tested its compilation using the following compilers.
 
 *   **Windows** - Visual Studio 2019
 *   **MacOS** - Apple Clang 11.0 (MacOS 10.15)
-*   **Linux** - LLVM Clang 10.0, GNU C Compiler 9.3.0
-
-Also, the module depends on Eigen for the linear algebra.
+*   **Linux** - LLVM Clang 10.0, GNU C Compiler 9.4.0
 
-*   [Eigen 3.x](http://eigen.tuxfamily.org/index.php)
-
-### C++ Library and Examples
+### Library and examples (C++)
 
 You can build a shared library and all the examples by `CMake` with the following commands.
 
@@ -58,12 +52,6 @@ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=ON ..
 cmake --build . --config Release --parallel 2
 ```
 
-#### Run examples (C++)
-
-```shell
-./build/bin/example_simplify data/models/bunny.ply
-```
-
 ### Python module
 
 You can install the Python module using `Pip`.
@@ -80,18 +68,69 @@ cd tinymesh
 poetry install
 ```
 
-#### Run examples (Python)
+Run examples
+---
+
+#### C++
+
+```shell
+./build/bin/example_simplify data/models/bunny.ply
+```
+
+#### Python
 
 ```shell
 python examples/python/fill_and_fair.py data/models/bunny.ply
 ```
 
-Screen shots
+Gallery
 ---
 
-| Input | Before | Simplified |
-|:--------:|:--------:|:--------:|
-|![](figures/dragon.jpg)|![](figures/dragon_before_simplify.jpg)|![](figures/dragon_after_simplify.jpg)|
+#### Remeshing
+
+<table>
+  <tr>
+    <td width="30%">Input</td>
+    <td width="30%">Remesh</td>
+    <td width="30%">Remesh (bottom part)</td>
+  </tr>
+  <tr>
+    <td width="30%"><img src="figures/bunny_before.png" width="100%"/></td>
+    <td width="30%"><img src="figures/bunny_remesh_1.png" width="100%"/></td>
+    <td width="30%"><img src="figures/bunny_remesh_2.png" width="100%"/></td>
+  </tr>
+</table>
+
+
+#### Simplification
+
+<table>
+  <tr>
+    <td width="30%">Input</td>
+    <td width="30%">Simplify (50000 faces)</td>
+    <td width="30%">Simplify (10000 faces)</td>
+  </tr>
+  <tr>
+    <td width="30%"><img src="figures/dragon_before.png" width="100%"/></td>
+    <td width="30%"><img src="figures/dragon_simplify_50000.png" width="100%"/></td>
+    <td width="30%"><img src="figures/dragon_simplify_10000.png" width="100%"/></td>
+  </tr>
+</table>
+
+#### Denoising (L0)
+
+<table>
+  <tr>
+    <td width="30%">Original</td>
+    <td width="30%">Noisy</td>
+    <td width="30%">Denoise</td>
+  </tr>
+  <tr>
+    <td width="30%"><img src="figures/fandisk_before.png" width="100%"/></td>
+    <td width="30%"><img src="figures/fandisk_noise.png" width="100%"/></td>
+    <td width="30%"><img src="figures/fandisk_denoise_l0.png" width="100%"/></td>
+  </tr>
+</table>
 
 Notice
 ---

data/models/fandisk.ply

@@ -24,19 +24,27 @@ int main(int argc, char **argv) {
         // Random number generator
         std::random_device randev;
         std::mt19937 mt(randev());
-        std::uniform_real_distribution<double> dist(-0.01, 0.01);
+        std::uniform_real_distribution<double> dist(-0.5, 0.5);
 
         // Save noise mesh
         std::string noiseMeshFile;
         {
             mesh::Mesh mesh(argv[1]);
             mesh::holeFill(mesh, Pi / 6.0);
 
+            double Lavg = 0.0;
+            for (int i = 0; i < (int)mesh.numEdges(); i++) {
+                mesh::Edge *e = mesh.edge(i);
+                const double l = e->length();
+                Lavg += l;
+            }
+            Lavg = Lavg / mesh.numEdges();
+
             // Add noise
             for (int i = 0; i < (int)mesh.numVertices(); i++) {
                 const Vec3 pos = mesh.vertex(i)->pos();
                 const Vec3 noise = Vec3(dist(mt), dist(mt), dist(mt));
-                mesh.vertex(i)->setPos(pos + noise);
+                mesh.vertex(i)->setPos(pos + Lavg * noise);
             }
             noiseMeshFile = (dirpath / fs::path((basename + "_noise" + extension).c_str())).string();
             mesh.save(noiseMeshFile);

examples/example_denoise.cpp

@@ -9,7 +9,7 @@
 def main(filename):
     mesh = Mesh(filename)
 
-    # Freeze faces
+    # Freeze vertices
     for i in range(mesh.num_vertices()):
         v = mesh.vertex(i)
         v.set_is_static(True)
@@ -18,17 +18,17 @@ def main(filename):
     hole_fill(mesh, np.pi / 6.0)
     print('[ OK ] hole filling')
 
-    # Then, remesh
+    # Remesh
     remesh_triangular(mesh, short_length=0.5, long_length=2.0)
     print('[ OK ] remeshing')
 
-    # Finally, fair
+    # Fairing
     implicit_fairing(mesh)
     print('[ OK ] fairing')
 
     # Save
     base, ext = os.path.splitext(filename)
-    outfile = base + "_remesh" + ext
+    outfile = base + '_fairing' + ext
     mesh.save(outfile)
     print('[ OK ] saved to %s' % (outfile))