Skip to content
Snippets Groups Projects
Commit 31ac1d0f authored by Emmanuel Christophe's avatar Emmanuel Christophe
Browse files

DOC: Adding doxygen information

parent cfb3b550
Branches
Tags
No related merge requests found
......@@ -24,7 +24,18 @@ namespace otb
{
/** \class PolygonCompacityFunctor
* \brief
* \brief Select polygons according to their compacity
*
* This functor compute the compacity of a polygon
* and return true is the distance is above the threshold, false otherwise.
*
* The compacity is defined as:
*
* \f$ 4\pi \frac{S}{L}\f$
*
* where \f$ S \f$ is the surface (obtained by the method GetSurface() )
* and \f$ L \f$ the perimeter (obtained by the method GetLength() ).
*
* \ingroup Functor
*/
template <class TInput1>
......
......@@ -29,7 +29,7 @@ namespace otb
* \brief This filter remove path considered as tortuous.
*
* A path is considered to be tortuous if the mean distance between each consecutive vertices
* is lower than the user provided threshold.
* is strictly lower than the user provided threshold.
*
* \sa BreakAngularPathListFilter
* \sa SimplifyPathFilter
......@@ -37,6 +37,8 @@ namespace otb
*<b>Recent API changes:</b>
* Now part of the UnaryFunctorObjectListBooleanFilter hierachy, replace call to SetMeanDistanceThreshold()
* by GetFunctor.SetThreshold().
*
* The inequality is now a strict one.
*
* \example FeatureExtraction/ExtractRoadByStepsExample.cxx
*
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment