update the HTML reports README

Author: sebmestrallet

definitions/algorithms/generate_report.README.md

@@ -1,130 +1,101 @@
-This folder contains the inputs & outputs of our algorithm, on the [MAMBO](https://gitlab.com/franck.ledoux/mambo/) dataset.
+# Validity-first automatic polycube labeling for CAD models - supplemental material
 
-Contrary to a supplemental material in the PDF format where the ordering is fixed and the 3D models are compressed into a set of 2D images, 
-you will be able to sort/filter by any column, and visualize the results in a 3D viewer.
+This folder contains the inputs & outputs of our algorithm, on the [MAMBO](https://gitlab.com/franck.ledoux/mambo/) and [OctreeMeshing](https://cims.nyu.edu/gcl/papers/2019-OctreeMeshing.zip) datasets, as well as results of _PolyCut_[^polycut] and _Evocube_[^evocube].
 
-# Important : Allow the access to local files
+## Open the interactive document
 
-However, for security reasons, internet navigators do not allow HTML files from accessing local files 
-([CORS error](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy#file_origins)), 
-such as the 3D models. You have 2 solutions:
+Our supplemental material do not require an internet connection. Rendering code is inside the `js/` subfolder and 3D models inside `glb/`.
 
-## 1. Temporarily change the security policy of your internet navigator
+By default, internet navigators do not allow both HTTP access and `file:///` access ([CORS error](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy#file_origins)).
+If you directly open `index.html` with your internet navigator, the 3D models will not be rendered.
 
-### Firefox
-
-Open `about:config` and change the value of `security.fileuri.strict_origin_policy` from `true` to `false`
-
-Then open `index.html`
-
-### Chrome
-
-Execute
+### Recommended: Launch a HTTP server with [Python](https://www.python.org/)
 
 ```bash
-google-chrome index.html --allow-file-access-from-files
+python -m http.server
 ```
 
-## 2. Launch an HTTP server
+Then open the printed address (usually http://0.0.0.0:8000/) with your internet navigator. Python will serve `index.html` locally and provide access to the 3D models through HTTP.
 
-For example with Python:
+### Other means to launch a HTTP server
 
-```bash
-python3 -m http.server
-```
+- with the [miniserve](https://github.com/svenstaro/miniserve) binary: `miniserve .`
+- with [PHP](https://www.php.net/): `php -S localhost:8080 -t .`
+- with the [http-server](https://www.npmjs.com/package/http-server) Node.js package: `http-server .`
+- with [Ruby](https://www.ruby-lang.org/en/) and [WEBrick](https://github.com/ruby/webrick): `ruby -run -ehttpd .`
 
-Then open http://0.0.0.0:8000/ with your internet navigator
+### Other method: Temporarily change the security policy of your internet navigator
 
-# Sankey diagram
+- with Firefox: open `about:config` and change the value of `security.fileuri.strict_origin_policy` from `true` to `false`, then open `index.html`
+- with Chrome: execute `google-chrome index.html --allow-file-access-from-files`
 
-Above the interactive grid, there is a collapsed section hiding a Sankey diagram, which gives high level stats about the batch execution 
-(for our method only, Evocube results are ignored).  
-You can adjust the vertical position of the nodes, and hovering them gives the number of models.
+## Sankey diagram
 
-# Column filters
+Above the interactive grid, there is a collapsed section hiding a Sankey diagram, which gives high level stats on our method only. You can adjust the vertical position of the nodes, and hovering them gives the number of models.
 
-To see only labelings generated by our method : hamburger button of the 'method' column → select Equals 'Ours' 
-([Set Filters](https://www.ag-grid.com/javascript-data-grid/filter-set/) are not available in the community edition of the library)
+## Column filters
 
-To see only invalid labelings : hamburger button of the 'valid' column → choose 'False'
+To see only labelings generated by our method : hamburger button of the "method" column → select Equals "Ours" 
+([Set Filters](https://www.ag-grid.com/javascript-data-grid/filter-set/) are not available in the community edition of the library).
 
-To see only failed labeling generations : for ex. hamburger button of the '#charts' column → choose 'Blank'. To reset, choose 'Equals' and leave empty
+To see only invalid labelings : hamburger button of the "valid" column → choose "False".
 
-# Column sort
+To see only failed labeling generations : e.g. hamburger button of the "#charts" column → choose "Blank". To reset, choose "Equals" and leave the field empty.
 
-You can click on the name of a column to switch between ascending, descending and default order.
+## Column sort
 
-# Columns description
+You can click on the name of a column to switch between ascending, descending and default order.
 
-- CAD model : name of the 3D model
+## Columns description
 
-- method : if the polycube labeling was generated using Evocube (Dumery et al. 2022) or our algorithm
+- CAD model : name of the 3D model. Bx, Sx and Mx models are from the MAMBO dataset, the others from OctreeMeshing
+- method : if the polycube labeling was generated using a graph-cut optimization (our initial labeling), _PolyCut_[^polycut], _Evocube_[^evocube] or our method
 
 "surface mesh" group
 
 - #vertices : number of vertices in the triangle mesh
-
 - #facets : number of facets in the triangle mesh
-
 - sd(area) : standard deviation of the facets area
 
 "labeling" group
 
 - #charts : number of charts
-
 - #boundaries : number of boundaries
-
 - #corners : number of corners
-
 - #invalid-charts : number of invalid charts
-
 - #invalid-boundaries : number of invalid boundaries
-
 - #invalid-corners : number of invalid corners
-
 - min(fidelity) : minimal (worse) per-triangle fidelity (closeness between the facet normal and the assigned direction). In [0,1]
-
 - avg(fidelity) : average per-triangle fidelity, in [0,1]
-
 - valid : if the labeling corresponds to a polycube topology or not
-
 - #turning-points : number of turning-points (high turns along boundaries)
-
-- duration : execution duration, of the labeling algorithm only, in seconds
-
-- speedup : duration of Evocube divided by the duration of our algorithm
-
-- open : open the 3D viewer. After 5s, the 3D model switches between the labeled mesh and a fast polycube estimation. If no labeling was generated, the triangle mesh is displayed instead. Screen space Ambient Occlusion (SSAO) is on by default.
+- duration : duration of the labeling stage with file I/O, in seconds. For our method, the generation of the initial labeling with graph-cut is 
+- relative duration : duration divided by the duration of our method
+- open : open the 3D viewer. After 5s, the 3D model switches between the labeled mesh and a fast polycube estimation. If no labeling was generated, the triangle mesh is displayed instead. Screen Space Ambient Occlusion (SSAO) is on by default.
 
 "feature edges" group
 
-- removed : percentage of CAD lines not considered feature edges because of their low dihedral angle
-
-- lost : percentage of lost feature edges because the same direction (label) is assigned on the 2 adjacent facets
-
-- preserved : percentage of preserved feature edge (between 2 different labels)
+- ignored : percentage of CAD lines not considered feature edges because of their low dihedral angle
+- sharp & lost : percentage of lost feature edges because the same direction (label) is assigned on the 2 adjacent facets
+- sharp & preserved : percentage of preserved feature edge (between 2 different labels)
 
 "hex-mesh" group
 
 - min(SJ) : minimal (worse) per-hexahedron scaled jacobian
-
 - avg(SJ) : average per-hexahedron scaled jacobian
+- open : open the 3D viewer. Screen Space Ambient Occlusion (SSAO) is off by default.
 
-- open : open the 3D viewer. Screen space Ambient Occlusion (SSAO) is off by default.
-
-# Comparison with PolyCut
-
-We wanted to compare our algorithm with PolyCut (Livesu et al. 2013). 
-However, we were unable to successfully run the executable provided by the authors (polycut.exe). 
-We did not get any output file and the logs were empty. 
-Following executables in pipeline.bat failed and printed "Input file missing".
-We contacted the corresponding author and did not get an answer before the submission deadline.
-
-# Acknowledgment
+## Acknowledgment
 
 The authors would like to thank contributors to the [AG Grid](https://github.com/ag-grid/ag-grid), 
 [d3-sankey](https://github.com/d3/d3-sankey), [model-viewer](https://github.com/google/model-viewer) 
 and [tinygltf](https://github.com/syoyo/tinygltf) libraries, as well as Khronos Group for the 
 standardization of the [glTF](https://www.khronos.org/gltf/) file format.
 
-Like our algorithm, data processing and the report generation will be made open-source.
+Like our algorithm, data processing and the report generation will be made open-source.
+
+---
+
+[^polycut]: M. Livesu, N. Vining, A. Sheffer, J. Gregson and R. Scateni, « PolyCut: Monotone Graph-Cuts for PolyCube Base-Complex Construction », in _Proceedings of SIGGRAPH Asia_, ACM, 2013. doi:[10.1145/2508363.2508388](https://doi.org/10.1145/2508363.2508388)
+
+[^evocube]: C. Dumery, F. Protais, S. Mestrallet, C. Bourcier and F. Ledoux, « Evocube: a Genetic Labeling Framework for Polycube-Maps », vol. 41, nᵒ 6, p. 467‑479, 2022, doi: [10.1111/cgf.14649](https://doi.org/10.1111/cgf.14649)