From 3ac684794be0f150f4a0014e4a57ebade817ad38 Mon Sep 17 00:00:00 2001
From: Guillaume Pasero <guillaume.pasero@c-s.fr>
Date: Wed, 11 Jun 2014 17:21:11 +0200
Subject: [PATCH] DOC: explain coordinate expected in vector data
---
Code/OBIA/otbLabelMapToVectorDataFilter.h | 6 +++++-
Code/OBIA/otbVectorDataToLabelMapWithAttributesFilter.h | 6 ++++++
2 files changed, 11 insertions(+), 1 deletion(-)
diff --git a/Code/OBIA/otbLabelMapToVectorDataFilter.h b/Code/OBIA/otbLabelMapToVectorDataFilter.h
index f620b2c5bc..d7d32de3f0 100644
--- a/Code/OBIA/otbLabelMapToVectorDataFilter.h
+++ b/Code/OBIA/otbLabelMapToVectorDataFilter.h
@@ -40,7 +40,11 @@ namespace otb {
* "An algorithm for the rapid computation of boundaries of run-length
* encoded regions", Francis K. H. Queck, in Pattern Recognition 33
* (2000), p 1637-1649.
- *
+ *
+ * Note : the output vector data contains index coordinates (not physical coordinates).
+ * For instance, a polygon around the pixel at index (0,0) would have the following
+ * points : [-0.5,-0.5] , [0.5,-0.5] , [0.5,0.5] , [-0.5,0.5]
+ *
* \sa VectorDataSource
* \ingroup GeoSpatialAnalysis
*/
diff --git a/Code/OBIA/otbVectorDataToLabelMapWithAttributesFilter.h b/Code/OBIA/otbVectorDataToLabelMapWithAttributesFilter.h
index 07eba6efb6..4cb0ce1b8c 100644
--- a/Code/OBIA/otbVectorDataToLabelMapWithAttributesFilter.h
+++ b/Code/OBIA/otbVectorDataToLabelMapWithAttributesFilter.h
@@ -48,6 +48,12 @@ namespace otb
* The first Label is set using SetInitialLabel (by default it is 0), and increases 1 by 1.
* The vector data attributes are also assigned to the object in the label map.
*
+ * When AutomaticSizeComputation=True, the spacing from the vector data object
+ * is used. Then the size and origin are computed so that the image extent
+ * covers exactly the vector data bounding region.
+ *
+ * Note : the coordinates in the vector data are assumed to be physical coordinates.
+ *
* \sa LabelMapSource
*/
--
GitLab