From 48038c973dfb98e48d5eace77f0bdfd283460ea5 Mon Sep 17 00:00:00 2001
From: Julien Michel <julien.michel@c-s.fr>
Date: Mon, 4 Jun 2007 15:21:43 +0000
Subject: [PATCH] documentation manquante.
---
.../otbVectorRescaleIntensityImageFilter.h | 11 ++++++++++-
Code/IO/otbSpatialObjectDXFReader.h | 3 ++-
2 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/Code/BasicFilters/otbVectorRescaleIntensityImageFilter.h b/Code/BasicFilters/otbVectorRescaleIntensityImageFilter.h
index 1b640ea924..5b4dba9088 100644
--- a/Code/BasicFilters/otbVectorRescaleIntensityImageFilter.h
+++ b/Code/BasicFilters/otbVectorRescaleIntensityImageFilter.h
@@ -30,6 +30,9 @@ namespace Functor {
/** \class VectorAffineTransform
* \brief This functor performs a per band linear transform of its input.
*
+ * Values upper than InputMaximum or lower than InputMinimum are clamped to OutputMaximum
+ * respectively OutputMinimum values.
+ *
* TInput and TOutput type are supposed to be of type itk::VariableLengthVector.
*
*/
@@ -156,7 +159,13 @@ namespace Functor {
/** \class VectorRescaleIntensityImageFilter
- * \brief
+ * \brief This filter performs a rescaling of a vector image on a per band basis.
+ *
+ * This filter rescales each band to match the [OutputMinimum,OutputMaximum] range.
+ * In order to avoid odd values to alter the intensity extent, one can set a clamp percentage.
+ *
+ * Values lower than the first quantile of this percentage are set to the OutputMinimum.
+ * Values upper than the last quantile of this percentage are set to the OutputMaximum.
*
* \ingroup IntensityImageFilters
* \ingroup MultiThreaded
diff --git a/Code/IO/otbSpatialObjectDXFReader.h b/Code/IO/otbSpatialObjectDXFReader.h
index 72792a6585..8f7ec2eca6 100755
--- a/Code/IO/otbSpatialObjectDXFReader.h
+++ b/Code/IO/otbSpatialObjectDXFReader.h
@@ -24,7 +24,8 @@ PURPOSE. See the above copyright notices for more information.
namespace otb
{
/** \class SpatialObjectDXFReader
- * \brief
+ * \brief This class reads the DXF file format to SpatialObjects.
+ *
* \ingroup ObjectSource
*/
template <class TSpatialObject>
--
GitLab