massaging user manual

This commit is contained in:
Pierre Alliez 2017-11-19 18:49:30 +01:00
parent 88e0d86f30
commit 8a4525ea05
1 changed files with 10 additions and 9 deletions

View File

@ -124,8 +124,9 @@ Class interface:
- `CGAL::VSA::Mesh_approximation`: allowing more customization of the proxy, metric and approximation process.
The input of the algorithm is expected to be:
- Combinatorially 2-manifold and oriented
- Triangulated
- Combinatorially 2-manifold
- Oriented
\section sma_examples Examples
@ -135,9 +136,9 @@ The following example calls the free function `CGAL::VSA::mesh_approximation()`
\cgalExample{Surface_mesh_approximation/vsa_approximation_example.cpp}
Note that the function parameters are provided through \ref namedparameters. To set the non-default parameter values we need to call the functions with the required parameters, connected by a dot and in an arbitrary order, as follows:
Note that the function parameters are provided through \ref namedparameters. Setting the non-default parameter values requires calling the functions with the required parameters, connected by a dot and in an arbitrary order, as follows:
TODO: add output indexed face set to the code below
TODO: add output indexed face set to the code below, and verify that it compiles.
\code
// input: input triangle surface mesh
@ -176,20 +177,20 @@ The class interface `CGAL::VSA::Mesh_approximation` offers a means to achieve fl
\cgalExample{Surface_mesh_approximation/vsa_class_interface_example.cpp}
\subsection sma_example4 Self-defined Proxy and Metric
\subsection sma_example4 Customized Proxy and Error Metric
\cgalFigureBegin{vsa_metric_comparison, vsa_metric_comparison_200_30.png}
Comparison of different metrics on the bear model, with 200 proxies and hierarchical seeding. From left to right: \f$ \mathcal{L}^{2,1} \f$ metric, \f$ \mathcal{L}^2 \f$ metric and compact metric.
\cgalFigureEnd
The following example defines a point-wise proxy to achieves an isotropic patch approximation of the shape. The output mesh is depicted in Figure \cgalFigureRef{vsa_metric_comparison}.
The following example defines a point-wise proxy to yield an isotropic approximation. The output mesh is depicted in Figure \cgalFigureRef{vsa_metric_comparison}.
\cgalExample{Surface_mesh_approximation/vsa_isotropic_metric_example.cpp}
\section sma_perf Performances
We provide some performance comparisons in this section with the free function API `CGAL::VSA::mesh_approximation`.
The machine used is a PC running Windows10 X64 with an Intel Xeon E5-1620 clocked at 3.70 GHz with 32GB of RAM.
We provide some performance comparisons with the free function API `CGAL::VSA::mesh_approximation`.
Timings are recorded on a PC running Windows10 X64 with an Intel Xeon E5-1620 clocked at 3.70 GHz with 32GB of RAM.
The program has been optimized with the O2 option with Visual Studio 2015. By default the kernel used is `Exact_predicates_inexact_constructions_kernel` (`EPICK`).
Runtime in seconds with target number of proxies of different seeding method:
@ -222,7 +223,7 @@ bear | 20,188 | 200 | 20 | 1.194 | 0.784 | 0
masque | 62,467 | 200 | 20 | 4.308 | 2.974 | 0.349 | 7.631
</center>
<!-- With different metrics, we compare the running time and complexity of the output mesh.
<!-- With different metrics, we record the running time and complexity of the output mesh.
<center>
Model | \#Triangles | \f$ \mathcal{L}^{2,1} \f$ | \f$ \mathcal{L}^2 \f$ | %Compact Metric
@ -236,7 +237,7 @@ masque | 62,467 | tbd | tbd |
The VSA method has two key geometric concepts:
- <b>Proxies</b> \f$ P \f$. The parameterized best-fit geometric surrogates of a piece of surface geometry.
- <b>Proxies</b> \f$ P \f$. The parameterized best-fit surrogates of a piece of surface geometry.
- <b>Error metrics</b> \f$ E \f$. To measure how well a proxy approximates the corresponding geometry.