From c06c4eaa756b50a8d85b3db4935a66f7732b26e0 Mon Sep 17 00:00:00 2001
From: Emmanuel Christophe <emmanuel.christophe@orfeo-toolbox.org>
Date: Wed, 3 Dec 2008 09:15:09 +0800
Subject: [PATCH] DOC: description for Jan Wegner contribution
---
.../FeatureExtraction/otbLinkPathListFilter.h | 5 +++++
.../otbParallelLinePathListFilter.h | 21 +++++++++++++++++--
2 files changed, 24 insertions(+), 2 deletions(-)
diff --git a/Code/FeatureExtraction/otbLinkPathListFilter.h b/Code/FeatureExtraction/otbLinkPathListFilter.h
index 63728f2646..ad5b512959 100644
--- a/Code/FeatureExtraction/otbLinkPathListFilter.h
+++ b/Code/FeatureExtraction/otbLinkPathListFilter.h
@@ -34,6 +34,11 @@ namespace otb
* Please note that this filter may invert the order of the vertices in the newly created path.
*
* This filter is part of the road extraction framework.
+ *
+ * \sa ParallelLinePathListFilter
+ *
+ * \ingroup PathFilters
+ *
*/
template <class TPath>
class ITK_EXPORT LinkPathListFilter
diff --git a/Code/FeatureExtraction/otbParallelLinePathListFilter.h b/Code/FeatureExtraction/otbParallelLinePathListFilter.h
index be647ad197..7ec50024fe 100644
--- a/Code/FeatureExtraction/otbParallelLinePathListFilter.h
+++ b/Code/FeatureExtraction/otbParallelLinePathListFilter.h
@@ -24,9 +24,26 @@ PURPOSE. See the above copyright notices for more information.
namespace otb
{
/** \class ParallelLinePathListFilter
- * \brief Description needed
- *
+ * \brief otbParallelLinePathListFilter detects parallel lines in imagery. The required input data are a pathlist object.
*
+ * The class consists of three basic functions that determine the angle between two lines,
+ * the distance between the lines and the common part of the lines. First, all input lines
+ * are checked if there is a second line running in the same direction. Thereafter, all line
+ * pairs that already fulfilled the angular criterion are checked whether they are close to
+ * each other or not, i.e. the orthogonal distance between them is calculated. Finally, it
+ * has to be verified if the two lines have a common part since lines may fulfil the two
+ * first criteria but be located in different parts of the image. In order to adapt the
+ * detection algorithm to the user’s needs, the thresholds AngularThreshold, DistanceThreshold
+ * and CommonDistanceThreshold can be set.
+ *
+ * A possible processing chain would be to extract lines with a line detector, to convert the
+ * result to pathlist objects, to link short line segments with the otbLinkPathListFilter to
+ * longer lines and to finally detect all parallel long lines.
+ *
+ * \sa LinkPathListFilter
+ *
+ * \ingroup PathFilters
+ *
*/
template <class TPath>
class ITK_EXPORT ParallelLinePathListFilter
--
GitLab