Fixing doc

DGtal-team · Feb 22, 2013 · 8ce1b5b · 8ce1b5b
1 parent fc2db4b
commit 8ce1b5b
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 23 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -19,8 +19,10 @@
     - Statistic class moved to math package
 
  *Kernel Package*
-    - digital sets are now also point predicates, update of DigitalSetDomain accordingly. As a consequence,
-SetPredicate is now deprecated.
+    - digital sets are now also point predicates, update of
+      DigitalSetDomain accordingly. As a consequence, SetPredicate is
+      now deprecated.
+
     - new documentation for module digital sets.
 
  *Arithmetic Package*
@@ -50,8 +52,8 @@ SetPredicate is now deprecated.
       DistanceTransformation, ReverseDistanceTransformation and
       preliminary medial axis extraction.
     - Separable volumetric tools are now multithread using OpenMP.
-	- New curvature estimator in 2D/3D based on integral invariants, which uses
-      to iterate a convolver around the shape surface.
+    - New curvature estimator in 2D/3D based on integral invariants
+      (both mean and gaussian curvatures in 3D).
 
  *Shape Package*
     - New operators available on digital and Euclidean shapes (Union,

diff --git a/src/DGtal/geometry/surfaces/DigitalSurfaceConvolver.h b/src/DGtal/geometry/surfaces/DigitalSurfaceConvolver.h
@@ -157,8 +157,8 @@ class DigitalSurfaceConvolver
   /**
        * Iterate the convolver between [itbegin, itend[.
        *
-       * @param itb (iterator of the) first spel on the surface of the shape where the convolution is computed.
-       * @param ite (iterator of the) last (excluded) spel on the surface of the shape where the convolution is computed.
+       * @param itbegin (iterator of the) first spel on the surface of the shape where the convolution is computed.
+       * @param itend (iterator of the) last (excluded) spel on the surface of the shape where the convolution is computed.
        * @param result iterator of an array where estimates quantities are set ( the estimated quantity from *itbegin till *itend (excluded)).
        */
   template< typename ConstIteratorOnCells, typename OutputIterator >
@@ -182,8 +182,8 @@ class DigitalSurfaceConvolver
   /**
        * Iterate the convolver between [itbegin, itend[ and return a covariance matrixfor each position.
        *
-       * @param itb (iterator of the) first spel on the surface of the shape where the covariance matrix is computed.
-       * @param ite (iterator of the) last (excluded) spel on the surface of the shape where the covariance matrix is computed.
+       * @param itbegin (iterator of the) first spel on the surface of the shape where the covariance matrix is computed.
+       * @param itend (iterator of the) last (excluded) spel on the surface of the shape where the covariance matrix is computed.
        * @param result iterator of an array where estimates covariance matrix are set ( the covariance matrix from *itbegin till *itend (excluded)).
        *
        * @tparam ConstIteratorOnCells iterator of a spel of the shape
@@ -345,8 +345,8 @@ class DigitalSurfaceConvolver< TFunctor, TKernelFunctor, TKSpace, TKernelConstIt
   /**
        * Iterate the convolver between [itbegin, itend[.
        *
-       * @param itb (iterator of the) first spel on the surface of the shape where the convolution is computed.
-       * @param ite (iterator of the) last (excluded) spel on the surface of the shape where the convolution is computed.
+       * @param itbegin (iterator of the) first spel on the surface of the shape where the convolution is computed.
+       * @param itend (iterator of the) last (excluded) spel on the surface of the shape where the convolution is computed.
        * @param result iterator of an array where estimates quantities are set ( the estimated quantity from *itbegin till *itend (excluded)).
        */
   template< typename ConstIteratorOnCells, typename OutputIterator >
@@ -371,8 +371,8 @@ class DigitalSurfaceConvolver< TFunctor, TKernelFunctor, TKSpace, TKernelConstIt
   /**
        * Iterate the convolver between [itbegin, itend[ and return a covariance matrixfor each position.
        *
-       * @param itb (iterator of the) first spel on the surface of the shape where the covariance matrix is computed.
-       * @param ite (iterator of the) last (excluded) spel on the surface of the shape where the covariance matrix is computed.
+       * @param itbegin (iterator of the) first spel on the surface of the shape where the covariance matrix is computed.
+       * @param itend (iterator of the) last (excluded) spel on the surface of the shape where the covariance matrix is computed.
        * @param result iterator of an array where estimates covariance matrix are set ( the covariance matrix from *itbegin till *itend (excluded)).
        *
        * @tparam ConstIteratorOnCells iterator of a spel of the shape
@@ -534,8 +534,8 @@ class DigitalSurfaceConvolver< TFunctor, TKernelFunctor, TKSpace, TKernelConstIt
   /**
        * Iterate the convolver between [itbegin, itend[.
        *
-       * @param itb (iterator of the) first spel on the surface of the shape where the convolution is computed.
-       * @param ite (iterator of the) last (excluded) spel on the surface of the shape where the convolution is computed.
+       * @param itbegin (iterator of the) first spel on the surface of the shape where the convolution is computed.
+       * @param itend (iterator of the) last (excluded) spel on the surface of the shape where the convolution is computed.
        * @param result iterator of an array where estimates quantities are set ( the estimated quantity from *itbegin till *itend (excluded)).
        */
   template< typename ConstIteratorOnCells, typename OutputIterator >
@@ -558,8 +558,8 @@ class DigitalSurfaceConvolver< TFunctor, TKernelFunctor, TKSpace, TKernelConstIt
   /**
        * Iterate the convolver between [itbegin, itend[ and return a covariance matrixfor each position.
        *
-       * @param itb (iterator of the) first spel on the surface of the shape where the covariance matrix is computed.
-       * @param ite (iterator of the) last (excluded) spel on the surface of the shape where the covariance matrix is computed.
+       * @param itbegin (iterator of the) first spel on the surface of the shape where the covariance matrix is computed.
+       * @param itend (iterator of the) last (excluded) spel on the surface of the shape where the covariance matrix is computed.
        * @param result iterator of an array where estimates covariance matrix are set ( the covariance matrix from *itbegin till *itend (excluded)).
        *
        * @tparam ConstIteratorOnCells iterator of a spel of the shape

diff --git a/src/DGtal/geometry/surfaces/estimation/IntegralInvariantGaussianCurvatureEstimator.h b/src/DGtal/geometry/surfaces/estimation/IntegralInvariantGaussianCurvatureEstimator.h
@@ -150,7 +150,7 @@ class IntegralInvariantGaussianCurvatureEstimator
   /**
       * Initialise the IntegralInvariantGaussianCurvatureEstimator with a specific Euclidean kernel re, and grid step h.
       *
-      * @param h precision of the grid
+      * @param _h precision of the grid
       * @param re Euclidean radius of the kernel support
       */
   void init ( const double _h, const double re );

diff --git a/src/DGtal/geometry/surfaces/estimation/IntegralInvariantMeanCurvatureEstimator.h b/src/DGtal/geometry/surfaces/estimation/IntegralInvariantMeanCurvatureEstimator.h
@@ -129,7 +129,7 @@ class IntegralInvariantMeanCurvatureEstimator
   /**
       * Initialise the IntegralInvariantMeanCurvatureEstimator with a specific Euclidean kernel radius re, and grid step h.
       *
-      * @param h precision of the grid
+      * @param _h precision of the grid
       * @param re Euclidean radius of the kernel support
       *
       * @bug known bug with radius of kernel. Small hack for the moment.
@@ -152,7 +152,7 @@ class IntegralInvariantMeanCurvatureEstimator
       * Return the result on an OutputIterator (param).
       *
       * @tparam ConstIteratorOnCells iterator on a Cell
-      * @tparam OutputIterator
+      * @tparam OutputIterator Output iterator type
       *
       * @param ite iterator of the begin position on the shape where we compute the integral invariant curvature.
       * @param itb iterator of the end position (excluded) on the shape where we compute the integral invariant curvature.
@@ -276,7 +276,7 @@ class IntegralInvariantMeanCurvatureEstimator<TKSpace, TShapeFunctor, 2>
   /**
       * Initialise the IntegralInvariantMeanCurvatureEstimator with a specific Euclidean kernel radius re, and grid step h.
       *
-      * @param h precision of the grid
+      * @param _h precision of the grid
       * @param re Euclidean radius of the kernel support
       *
       * @bug known bug with radius of kernel. Small hack for the moment.
@@ -300,7 +300,7 @@ class IntegralInvariantMeanCurvatureEstimator<TKSpace, TShapeFunctor, 2>
       * Return the result on an OutputIterator (param).
       *
       * @tparam ConstIteratorOnCells iterator on a Cell
-      * @tparam OutputIterator
+      * @tparam OutputIterator output iterator type
       *
       * @param ite iterator of the begin position on the shape where we compute the integral invariant curvature.
       * @param itb iterator of the end position (excluded) on the shape where we compute the integral invariant curvature.
@@ -428,7 +428,7 @@ class IntegralInvariantMeanCurvatureEstimator<TKSpace, TShapeFunctor, 3>
   /**
       * Initialise the IntegralInvariantMeanCurvatureEstimator with a specific Euclidean kernel radius re, and grid step h.
       *
-      * @param h precision of the grid
+      * @param _h precision of the grid
       * @param re Euclidean radius of the kernel support
       */
   void init ( const double _h, const double re );
@@ -449,7 +449,7 @@ class IntegralInvariantMeanCurvatureEstimator<TKSpace, TShapeFunctor, 3>
       * Return the result on an OutputIterator (param).
       *
       * @tparam ConstIteratorOnCells iterator on a Cell
-      * @tparam OutputIterator
+      * @tparam OutputIterator output iterator type
       *
       * @param ite iterator of the begin position on the shape where we compute the integral invariant curvature.
       * @param itb iterator of the end position (excluded) on the shape where we compute the integral invariant curvature.