From 3f2ef7a1ca0b7a20facd86bf479848ec14b9a04c Mon Sep 17 00:00:00 2001
From: Julien Michel <julien.michel@cnes.fr>
Date: Tue, 10 Nov 2015 10:51:24 +0100
Subject: [PATCH] DOC: Adding more documentation to resolve issue #514
---
.../include/otbShiftScaleVectorImageFilter.h | 8 ++++++++
.../Statistics/include/otbShiftScaleSampleListFilter.h | 3 +++
2 files changed, 11 insertions(+)
diff --git a/Modules/Filtering/ImageManipulation/include/otbShiftScaleVectorImageFilter.h b/Modules/Filtering/ImageManipulation/include/otbShiftScaleVectorImageFilter.h
index 26422e340c..431bd73669 100644
--- a/Modules/Filtering/ImageManipulation/include/otbShiftScaleVectorImageFilter.h
+++ b/Modules/Filtering/ImageManipulation/include/otbShiftScaleVectorImageFilter.h
@@ -142,6 +142,14 @@ private:
/** \class ShiftScaleVectorImageFilter
* \brief This filter performs a shift and scaling of a vector image on a per band basis.
*
+ * For each band, the following formula is applied :
+ *
+ * \f[ output = \frac{input - shift}{scale} \f]
+ *
+ * Beware that the behaviour differs from itk::ShiftScaleImageFilter
+ * (which add shift instead of subtracting it).
+ *
+ * \sa VectorShiftScale
* \ingroup IntensityImageFilters
* \ingroup MultiThreaded
*
diff --git a/Modules/Filtering/Statistics/include/otbShiftScaleSampleListFilter.h b/Modules/Filtering/Statistics/include/otbShiftScaleSampleListFilter.h
index 86449478a6..2a5b07a391 100644
--- a/Modules/Filtering/Statistics/include/otbShiftScaleSampleListFilter.h
+++ b/Modules/Filtering/Statistics/include/otbShiftScaleSampleListFilter.h
@@ -31,6 +31,9 @@ namespace Statistics {
*
* \f[ output = \frac{input - shift}{scale} \f]
*
+ * Beware that the behaviour differs from itk::ShiftScaleImageFilter
+ * (which add shift instead of subtracting it).
+ *
* Standard casting is applied between input and output type.
*
* Shifts and scales can be set via the SetShift() and SetScales() methods.
--
GitLab