From 514f714f8fcbfb38d1a15c5a8b736e8551b96f6b Mon Sep 17 00:00:00 2001
From: Emmanuel Christophe <emmanuel.christophe@orfeo-toolbox.org>
Date: Fri, 20 Aug 2010 12:02:00 +0800
Subject: [PATCH] DOC: fix doxygen
---
Code/FeatureExtraction/otbParallelLinePathListFilter.h | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/Code/FeatureExtraction/otbParallelLinePathListFilter.h b/Code/FeatureExtraction/otbParallelLinePathListFilter.h
index adf67a7f94..c0c27faf6b 100644
--- a/Code/FeatureExtraction/otbParallelLinePathListFilter.h
+++ b/Code/FeatureExtraction/otbParallelLinePathListFilter.h
@@ -24,21 +24,22 @@
namespace otb
{
/** \class ParallelLinePathListFilter
- * \brief otbParallelLinePathListFilter detects parallel lines in imagery. The required input data are a pathlist object.
+ * \brief 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
+ * has to be verified if the two lines have a common part since lines may fulfill 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.
+ * result to PathList object (an ObjectList of PolyLineParametricPath), to link short line
+ * segments with the otbLinkPathListFilter to longer lines and to finally detect all parallel
+ * long lines.
*
* \sa LinkPathListFilter
*
--
GitLab