Merge pull request #460 from DGtal-team/docvolscope

volscope documentation
DGtal-team · May 26, 2024 · b413c44 · b413c44
2 parents 8f6338f + a5c4f78
commit b413c44
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 2 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -27,6 +27,8 @@
     [#452](https://github.com/DGtal-team/DGtalTools/pull/452))
   - volscope new vol visualization tool using polyscope (David Coeurjolly, 
     [#455](https://github.com/DGtal-team/DGtalTools/pull/455))
+  - volscope documentation enhanced (David Coeurjolly, 
+    [#460](https://github.com/DGtal-team/DGtalTools/pull/460))
 
 - *volumetric*
     - volReSample: fix the impossibility to export to vol when ITK is activated

diff --git a/README.md b/README.md
@@ -198,7 +198,7 @@ Galleries
    <td  align="center" colspan="2"><a href="https://dgtal-team.github.io/doctools-nightly/Doc3dImplicitSurfaceExtractorByThickening.html" > 3dImplicitSurfaceExtractorByThickening</a> </td>
    </tr>
 <tr>
-       <td align="center" colspan="2"><img width=250 src="https://private-user-images.githubusercontent.com/700165/292447134-04037898-33e8-48f5-855c-d7432fe061e8.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MDYzOTA1NTUsIm5iZiI6MTcwNjM5MDI1NSwicGF0aCI6Ii83MDAxNjUvMjkyNDQ3MTM0LTA0MDM3ODk4LTMzZTgtNDhmNS04NTVjLWQ3NDMyZmUwNjFlOC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwMTI3JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDEyN1QyMTE3MzVaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT04ZmRhODA5YTg2ODQ4Mzg1YzBiZDNlYWRiYmY0NzYxNDYyMzRhNTlkMWM0NDY4MDM5MDBkYmQ3OGJmYzE1YzA3JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.LZ85J7dmRixTVIqho3NLnSQjllhEttiX7Z2yki3xNtk"</td>
+       <td align="center" colspan="2"><img width=250 src="doc/images/volscope-surface.png"</td>
 
 </tr>
       <tr>

diff --git a/doc/images/volscope-surface.png b/doc/images/volscope-surface.png
diff --git a/doc/images/volscope-volumetric.png b/doc/images/volscope-volumetric.png
diff --git a/doc/visualization.dox b/doc/visualization.dox
@@ -18,7 +18,7 @@
 
 @section visualization_Doc Visualization
 
-
+  - @ref volscope : a new generic VOL file viewer using polyscope.
   - @ref Doc2dCompImage : compare images and displays differences (squared and absolute differences). 
   - @ref CompSurfelData : computes generic scalar surfel data comparisons (squared error) ( given from an input data file and from a reference one). 
   - @ref Doc3DCurvatureViewer :  permits to compute and visualize mean or gaussian curvature of binary shapes.

diff --git a/visualisation/volscope.cpp b/visualisation/volscope.cpp
@@ -70,6 +70,15 @@ typedef Shortcuts<Z3i::KSpace> SH3;
 -m,  --min INT                             For isosurface visualization and voxel filtering, specifies the threshold min (excluded) (default: 0).
  -M, --max INT                             For isosurface visualization and voxel filtering, specifies the threshold max (included) (default: 255).
  @endcode
+
+
+ @image html volscope-surface.png "Default visualization mode." width=50%
+
+ @image html volscope-volumetric.png "Volumetric visualization using polyscope slice planes."  width=50%
+
+
+
+
 **/
 
 int main(int argc, char**argv)