Fix typos in Doxygen documentation

estimators/lengthEstimators.cpp

@@ -75,7 +75,7 @@ using namespace DGtal;
  @page lengthEstimators lengthEstimators
 
 
- @brief Generates multigrid length estimations of paramteric shapes using DGtal library.
+ @brief Generates multigrid length estimations of parametric shapes using DGtal library.
  @ingroup estimatortools
 
 It will output length estimations (and timings) using several algorithms for decreasing grid steps.

estimators/volSurfaceRegularization.cpp

@@ -37,7 +37,7 @@
  @brief Regularize a cubical complex into a smooth quadrangulated complex.
  @ingroup estimatortools
 
- This is done by minimizing a quadratic energy function as decribed in ??. The variational
+ This is done by minimizing a quadratic energy function as described in ??. The variational
  formulation regularizes the position while aligning the regularized quads with an 
  input normal vector field. In this tool, the input normal vector field can be either 
  specified in the CSV input file, or computed using Integral Invariant (and -r option).

visualisation/3dCurvatureViewer.cpp

@@ -104,8 +104,8 @@ using namespace functors;
                                          type of output : mean, gaussian, k1, k2, prindir1, prindir2 or normal(default mean)
    -o,--exportOBJ TEXT                   Export the scene to specified OBJ/MTL filename (extensions added).
    -d,--exportDAT TEXT                   Export resulting curvature (for mean, gaussian, k1 or k2 mode) in a simple data file each line representing a surfel.
-   --exportOnly                          Used to only export the result without the 3d Visualisation (usefull for scripts).
-   -s,--imageScale FLOAT x 3             scaleX, scaleY, scaleZ: re sample the source image according with a grid of size 1.0/scale (usefull to compute curvature on image defined on anisotropic grid). Set by default to 1.0 for the three axis.
+   --exportOnly                          Used to only export the result without the 3d Visualisation (useful for scripts).
+   -s,--imageScale FLOAT x 3             scaleX, scaleY, scaleZ: re sample the source image according with a grid of size 1.0/scale (useful to compute curvature on image defined on anisotropic grid). Set by default to 1.0 for the three axis.
 
 
  @endcode
@@ -181,7 +181,7 @@ int main( int argc, char** argv )
   std::vector< double> vectScale;
 
 
-  app.description("Visualisation of 3d curvature from .vol file using curvature from Integral Invarian\nBasic usage:\n \t3dCurvatureViewer file.vol --radius 5 --mode mean  \n Below are the different available modes: \n\t - \"mean\" for the mean curvature \n \t - \"mean\" for the mean curvature\n\t - \"gaussian\" for the Gaussian curvature\n\t - \"k1\" for the first principal curvature\n\t - \"k2\" for the second principal curvature\n\t - \"prindir1\" for the first principal curvature direction\n\t - \"prindir2\" for the second principal curvature direction\n\t - \"normal\" for the normal vector\n Example: 3dCurvatureViewer --radius 20 --mode mean ${DGtal}/examples/samples/lobster.vol -l 110 ");
+  app.description("Visualisation of 3d curvature from .vol file using curvature from Integral Invariant\nBasic usage:\n \t3dCurvatureViewer file.vol --radius 5 --mode mean  \n Below are the different available modes: \n\t - \"mean\" for the mean curvature \n \t - \"mean\" for the mean curvature\n\t - \"gaussian\" for the Gaussian curvature\n\t - \"k1\" for the first principal curvature\n\t - \"k2\" for the second principal curvature\n\t - \"prindir1\" for the first principal curvature direction\n\t - \"prindir2\" for the second principal curvature direction\n\t - \"normal\" for the normal vector\n Example: 3dCurvatureViewer --radius 20 --mode mean ${DGtal}/examples/samples/lobster.vol -l 110 ");
 
 
 
@@ -197,9 +197,9 @@ int main( int argc, char** argv )
    app.add_option("--mode,-m", mode, "type of output : mean, gaussian, k1, k2, prindir1, prindir2 or normal(default mean)")
     -> check(CLI::IsMember({"mean","gaussian", "k1", "k2", "prindir1","prindir2", "normal" }));
    app.add_option("--exportDAT,-d",export_dat_filename, "Export resulting curvature (for mean, gaussian, k1 or k2 mode) in a simple data file each line representing a surfel."  );
-   app.add_flag("--exportOnly", exportOnly, "Used to only export the result without the 3d Visualisation (usefull for scripts).");
+   app.add_flag("--exportOnly", exportOnly, "Used to only export the result without the 3d Visualisation (useful for scripts).");
 
-   app.add_option("--imageScale,-s", vectScale,  "scaleX, scaleY, scaleZ: re sample the source image according with a grid of size 1.0/scale (usefull to compute curvature on image defined on anisotropic grid). Set by default to 1.0 for the three axis.")
+   app.add_option("--imageScale,-s", vectScale,  "scaleX, scaleY, scaleZ: re sample the source image according with a grid of size 1.0/scale (useful to compute curvature on image defined on anisotropic grid). Set by default to 1.0 for the three axis.")
     ->expected(3);
 
    app.get_formatter()->column_width(40);

visualisation/3dCurvatureViewerNoise.cpp

@@ -105,8 +105,8 @@ using namespace functors;
                                          type of output : mean, gaussian, k1, k2, prindir1, prindir2 or normal(default mean)
    -o,--exportOBJ TEXT                   Export the scene to specified OBJ/MTL filename (extensions added).
    -d,--exportDAT TEXT                   Export resulting curvature (for mean, gaussian, k1 or k2 mode) in a simple data file each line representing a surfel.
-   --exportOnly                          Used to only export the result without the 3d Visualisation (usefull for scripts).
-   -s,--imageScale FLOAT x 3             scaleX, scaleY, scaleZ: re sample the source image according with a grid of size 1.0/scale (usefull to compute curvature on image defined on anisotropic grid). Set by default to 1.0 for the three axis.
+   --exportOnly                          Used to only export the result without the 3d Visualisation (useful for scripts).
+   -s,--imageScale FLOAT x 3             scaleX, scaleY, scaleZ: re sample the source image according with a grid of size 1.0/scale (useful to compute curvature on image defined on anisotropic grid). Set by default to 1.0 for the three axis.
 
 
  @endcode
@@ -202,9 +202,9 @@ int main( int argc, char** argv )
   app.add_option("--mode,-m", mode, "type of output : mean, gaussian, k1, k2, prindir1, prindir2 or normal(default mean)")
    -> check(CLI::IsMember({"mean","gaussian", "k1", "k2", "prindir1","prindir2", "normal" }));
   app.add_option("--exportDAT,-d",export_dat_filename, "Export resulting curvature (for mean, gaussian, k1 or k2 mode) in a simple data file each line representing a surfel."  );
-  app.add_flag("--exportOnly", exportOnly, "Used to only export the result without the 3d Visualisation (usefull for scripts).");
+  app.add_flag("--exportOnly", exportOnly, "Used to only export the result without the 3d Visualisation (useful for scripts).");
 
-  app.add_option("--imageScale,-s", vectScale,  "scaleX, scaleY, scaleZ: re sample the source image according with a grid of size 1.0/scale (usefull to compute curvature on image defined on anisotropic grid). Set by default to 1.0 for the three axis.")
+  app.add_option("--imageScale,-s", vectScale,  "scaleX, scaleY, scaleZ: re sample the source image according with a grid of size 1.0/scale (useful to compute curvature on image defined on anisotropic grid). Set by default to 1.0 for the three axis.")
    ->expected(3);
 
   app.get_formatter()->column_width(40);

visualisation/3dCurveViewer.cpp

@@ -47,7 +47,7 @@
  Options:
    -h,--help                             Print this help message and exit
    -i,--input TEXT:FILE REQUIRED         the name of the text file containing the list of 3D points (x y z per line).
-   -b,--box INT=0                        specifies the the tightness of the bounding box around the curve with a given integer displacement <arg> to enlarge it (0 is tight)
+   -b,--box INT=0                        specifies the tightness of the bounding box around the curve with a given integer displacement <arg> to enlarge it (0 is tight)
    -v,--viewBox TEXT:{WIRED,COLORED}=WIRED
                                          displays the bounding box, <arg>=WIRED means that only edges are displayed, <arg>=COLORED adds colors for planes (XY is red, XZ green, YZ, blue).
    -C,--curve3d                          displays the 3D curve.
@@ -383,7 +383,7 @@ int main(int argc, char **argv)
   app.add_option("-i,--input,1", inputFileName, "the name of the text file containing the list of 3D points (x y z per line)." )
   ->required()
   ->check(CLI::ExistingFile);
-  app.add_option("--box,-b",b, "specifies the the tightness of the bounding box around the curve with a given integer displacement <arg> to enlarge it (0 is tight)");
+  app.add_option("--box,-b",b, "specifies the tightness of the bounding box around the curve with a given integer displacement <arg> to enlarge it (0 is tight)");
   app.add_option("--viewBox,-v",viewBox, "displays the bounding box, <arg>=WIRED means that only edges are displayed, <arg>=COLORED adds colors for planes (XY is red, XZ green, YZ, blue)." )
    -> check(CLI::IsMember({"WIRED", "COLORED"}));
 

visualisation/3dSDPViewer.cpp

@@ -79,7 +79,7 @@ typedef PolyscopeViewer<Z3i::Space, Z3i::KSpace> Viewer;
    --importColorLabels                   import color labels from the input file (label index  should be by default at index 3).
    --setColorLabelIndex UINT=3           customize the index of the imported color labels in the source file (used by -importColorLabels).
    -f,--filter FLOAT=100                 filter input file in order to display only the [arg] percent of the input 3D points (uniformly selected).
-   --noPointDisplay                      usefull for instance to only display the lines between points.
+   --noPointDisplay                      useful for instance to only display the lines between points.
    --drawLines                           draw the line between discrete points.
    -x,--scaleX FLOAT=1                   set the scale value in the X direction
    -y,--scaleY FLOAT=1                   set the scale value in the Y direction
@@ -202,7 +202,7 @@ int main(int argc, char **argv)
   app.add_flag("--importColorLabels", importColorLabels, "import color labels from the input file (label index  should be by default at index 3).");
   app.add_option("--setColorLabelIndex", colorLabelIndex, "customize the index of the imported color labels in the source file (used by -importColorLabels).");
   app.add_option("--filter,-f", filterValue, "filter input file in order to display only the [arg] percent of the input 3D points (uniformly selected).");
-  app.add_flag("--noPointDisplay", noPointDisplay, "usefull for instance to only display the lines between points.");
+  app.add_flag("--noPointDisplay", noPointDisplay, "useful for instance to only display the lines between points.");
   app.add_flag("--drawLines", drawLines, "draw the line between discrete points.");
   app.add_option("--scaleX,-x", sx, "set the scale value in the X direction");
   app.add_option("--scaleY,-y", sy, "set the scale value in the Y direction");

volumetric/volShapeMetrics.cpp

@@ -270,7 +270,7 @@ int main(int argc, char**argv)
   bool displayTFstats {false};
   bool exportSDP {false};
 
-  app.description("Apply shape measures for comparing two volumetric images A and B (shape defined from thresholds).\n It can compute: \n  - voxel count from voxel partition (number of voxel from (B-A), (A-B) ...): usefull to determine classical statistics like false positive related stats.\n - euclidean distance between two volumetric images A and B\n Basic usage: \t volShapeMetrics --volA <volAFilename> --volB <volBFilename>\nTypical use :\n  volShapeMetrics -a imageA.vol --aMin 128 --aMax 255 -b imageB.vol --bMin 128 --bMax 255 --distancesFromBnotInAOnly \n");
+  app.description("Apply shape measures for comparing two volumetric images A and B (shape defined from thresholds).\n It can compute: \n  - voxel count from voxel partition (number of voxel from (B-A), (A-B) ...): useful to determine classical statistics like false positive related stats.\n - euclidean distance between two volumetric images A and B\n Basic usage: \t volShapeMetrics --volA <volAFilename> --volB <volBFilename>\nTypical use :\n  volShapeMetrics -a imageA.vol --aMin 128 --aMax 255 -b imageB.vol --bMin 128 --bMax 255 --distancesFromBnotInAOnly \n");