Renaming ShapeGenerator to generators

CMakeLists.txt

@@ -76,7 +76,7 @@ message(STATUS "----------------------------------------------------------------
 
 #------Tools subdirectories ------
 add_subdirectory(volumetric)
-add_subdirectory(shapeGenerator)
+add_subdirectory(generators)
 add_subdirectory(estimators)
 add_subdirectory(converters)
 add_subdirectory(visualisation)

ChangeLog.md

@@ -4,11 +4,12 @@
   - doxygen documentation added for all tools. (David Coeurjolly, Bertrand Kerautret, [#258]((https://github.com/DGtal-team/DGtalTools/pull/258))
   - fix uses of temporaries when ConstAlias is needed.
     (Roland Denis, [#253](https://github.com/DGtal-team/DGtalTools/pull/253))
+  - renaming of the shapeGenerator folder to generators (David Coeurjolly, [#268](https://github.com/DGtal-team/DGtalTools/pull/268)))
 
 - *visualisation*:
   - 3dSDPViewer: add the possibility to display a set of point by using
     different sphere sizes (specified in the input sdp file).
-   (Bertrand Kerautret, 
+   (Bertrand Kerautret,
    [#252](https://github.com/DGtal-team/DGtalTools/pull/252))
 
   - sliceViewer: fix bug when imported image domain doesn't contain (0,0,0) point.

README.md

@@ -41,7 +41,7 @@ Actually the DGTal project is organized as follows:
 
  - [Estimators](#estimators)
 
- - [ShapeGenerator](#shapegenerator)
+ - [Generators](#generators)
 
  - [Visualization](#visualization)
 
@@ -162,7 +162,7 @@ Estimators
 </tr>
 </table>
 
-ShapeGenerator
+Generators
 --------------
   - contourGenerator: generate multigrid shape contours.
   - shapeGenerator: generate multigrid shape.
@@ -177,7 +177,7 @@ ShapeGenerator
 <td> grid size = 1</td> <td> grid size= 0.1</td> <td> grid size = 0.01</td>
 </tr>
 <tr>
-<td colspan=3 > Illustration of the shapeGenerator tools </td>
+<td colspan=3 > Illustration of the Generators tools </td>
 </tr>
 </table>
 </center>

doc/doxy.config.in

@@ -778,7 +778,7 @@ INPUT                  = @top_srcdir@/doc \
                          @top_srcdir@/converters \
                          @top_srcdir@/visualisation \
                          @top_srcdir@/estimators \
-                         @top_srcdir@/shapeGenerator \
+                         @top_srcdir@/generators \
                          @top_srcdir@/geometricTransform \
                          @top_srcdir@/volumetric
 

doc/shapeGenerator.dox → doc/generators.dox

@@ -1,44 +1,44 @@
 /**
- * @file shapeGenerator.dox
- * @author Bertrand Kerautret 
+ * @file generators.dox
+ * @author Bertrand Kerautret
  * LORIA (CNRS, UMR 7503), University of Lorraine, France
  *
  * @date 2016/05/09
  *
- * Documentation file for shapeGenerator
+ * Documentation file for generators
  *
  * This file is part of the DGtal library.
  */
 
 
 //----------------------------------------
 /*!
-@page shapeGenerator
+@page generators Generators
 @writers Bertrand Kerautret
 
-@section shapeGenerator_Doc Shape Generator
+
 
 
 Utilities to generate various contours/shapes:
 
   - @ref contourGenerator :  generates multigrid contours of 2d digital shapes using DGtal library.
   - @ref shapeGenerator : generates shapes using DGtal library.
-
 
+
 
 
 <center>
 <table>
 
   <tr>
-        <td><img height=200px src="resContourGenerator.png"></td>             
-        <td><img height=200px src="resShapeGenerator.png"></td>        
+        <td><img height=200px src="resContourGenerator.png"></td>
+        <td><img height=200px src="resShapeGenerator.png"></td>
   </tr>
   <tr>
   <td align=center>@ref contourGenerator</td>
-  <td align=center>@ref shapeGeneratorPrg </td>
+  <td align=center>@ref shapeGenerator </td>
   </tr>
- 
+
 
 
 </table>

doc/mainpage.dox

@@ -33,60 +33,61 @@ Actually the DGTal project is organized as follows:
 
  - [Estimators](\ref estimators_Doc)
 
- - [ShapeGenerator](\ref shapeGenerator_Doc)
+ - [Generators](\ref generators)
 
  - [Visualization](\ref visualization)
- 
+
  - [Volumetric](\ref volumetric_Doc)
 
 
    <center>
     <table>
     <tr bgcolor="#FAFFFA">
-    <td align = center colspan="3" vertical-align=middle> Example of tools of section  @ref converters : </td> 
+    <td align = center colspan="3" vertical-align=middle> Example of tools of section  @ref converters : </td>
     </tr>
     <tr>
     <td> <img height=150px src="resVol2sdp.png"> </td>
         <td><img height=150px src="resMesh2heightfield.png"></td>
-        <td><img height=150px src="resVolAddnoise.png"></td>        
+        <td><img height=150px src="resVolAddnoise.png"></td>
     </tr>
     <tr>
            <td align = center>@ref vol2sdp </td>
-           <td align = center>@ref mesh2heightfield </td>   
+           <td align = center>@ref mesh2heightfield </td>
            <td align = center>@ref volAddNoise</td>
-   </tr>   
+   </tr>
 
     <tr bgcolor="#FAFFFA">
-   <td align = center colspan="3" vertical-align=middle> Example of tools of section @ref estimators_Doc : </td> 
+   <td align = center colspan="3" vertical-align=middle> Example of tools of section @ref estimators_Doc : </td>
    </tr>
    <tr>
    <td>    <img height=150px src="res3dCurveTangentEstimator.png"> </td>
            <td><img height=150px src="res2dLocalEstimators.png"></td>
-           <td><img height=150px src="resGeneric3dNormalEstimatorsII.png"></td>        
+           <td><img height=150px src="resGeneric3dNormalEstimatorsII.png"></td>
    </tr>
       <tr>
            <td align = center>@ref Doc3dCurveTangentEstimator </td>
-           <td align = center>@ref Doc2dLocalEstimators </td>   
+           <td align = center>@ref Doc2dLocalEstimators </td>
            <td align = center>@ref generic3dNormalEstimators</td>
    </tr>
 
 
 
    <tr bgcolor="#FAFFFA">
-    <td align = center colspan="3" vertical-align=middle> Example of tools of section @ref shapeGenerator_Doc : </td> 
+    <td align = center colspan="3" vertical-align=middle> Example of tools of section @ref generators : </td>
    </tr>
    <tr>
-   <td center colspan="2">    <img height=150px src="resContourGenerator.png"> </td>
+   <td center colspan="2">
+           <img height=150px src="resContourGenerator.png"> </td>
            <td><img height=150px src="resShapeGenerator.png"></td>
    </tr>
       <tr>
-           <td align = center colspan="2">@ref  contourGenerator </td>   
-           <td align = center>@ref shapeGeneratorPrg </td>
+           <td align = center colspan="2"> @ref  contourGenerator </td>
+           <td align = center> @ref shapeGenerator </td>
    </tr>
 
 
    <tr bgcolor="#FAFFFA">
-    <td align = center colspan="3" vertical-align=middle> Example of tools of section @ref visualization_Doc : </td> 
+    <td align = center colspan="3" vertical-align=middle> Example of tools of section @ref visualization_Doc : </td>
    </tr>
    <tr>
    <td><img height=150px src="res3dCurvatureViewerNoise.png"> </td>
@@ -95,14 +96,14 @@ Actually the DGTal project is organized as follows:
 
    </tr>
       <tr>
-           <td align = center>@ref Doc3DCurvatureViewerNoise </td>   
+           <td align = center>@ref Doc3DCurvatureViewerNoise </td>
            <td align = center>@ref Doc3dVolViewer </td>
            <td align = center>@ref sliceViewer </td>
 </tr>
 
 
    <tr bgcolor="#FAFFFA">
-    <td align = center colspan="3" vertical-align=middle> Example of tools of section @ref volumetric_Doc : </td> 
+    <td align = center colspan="3" vertical-align=middle> Example of tools of section @ref volumetric_Doc : </td>
    </tr>
    <tr>
    <td><img height=150px src="res3dVolMarchingCubes2.png"> </td>
@@ -111,7 +112,7 @@ Actually the DGTal project is organized as follows:
 
    </tr>
       <tr>
-           <td align = center>@ref Doc3dVolMarchingCubes </td>   
+           <td align = center>@ref Doc3dVolMarchingCubes </td>
            <td align = center>@ref homotopicThinning3D </td>
            <td align = center>@ref volReSample </td>
 </tr>

shapeGenerator/contourGenerator.cpp → generators/contourGenerator.cpp

@@ -67,7 +67,9 @@
 using namespace DGtal;
 
 /**
+ *
  @page contourGenerator contourGenerator
+
  @brief  Generates multigrid contours of 2d digital shapes using DGtal library.
 
  The associated geometric information like contour, curvature can also be displayed.