From bb25eae9b9ccc2f0fd46d0d5dc88e8158a07877e Mon Sep 17 00:00:00 2001
From: Emmanuel Christophe <emmanuel.christophe@orfeo-toolbox.org>
Date: Mon, 27 Apr 2009 11:11:20 +0800
Subject: [PATCH] DOC: doxygen fix
---
Code/MultiScale/otbWaveletFilterBank.h | 78 +++++++++++++-------------
1 file changed, 39 insertions(+), 39 deletions(-)
diff --git a/Code/MultiScale/otbWaveletFilterBank.h b/Code/MultiScale/otbWaveletFilterBank.h
index 70ba28f910..d96864d5d6 100644
--- a/Code/MultiScale/otbWaveletFilterBank.h
+++ b/Code/MultiScale/otbWaveletFilterBank.h
@@ -9,11 +9,11 @@
Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
See OTBCopyright.txt for details.
- Copyright (c) Institut Telecom / Telecom Bretagne. All rights reserved.
+ Copyright (c) Institut Telecom / Telecom Bretagne. All rights reserved.
See ITCopyright.txt for details.
- This software is distributed WITHOUT ANY WARRANTY; without even
- the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ This software is distributed WITHOUT ANY WARRANTY; without even
+ the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
@@ -38,11 +38,11 @@ namespace otb {
* \brief One level stationary wavelet transform
*
* This implementation performs a low-pass / high-pass wavelet transformation
- * of an image. The wavelet transformation is defined by a inner product
+ * of an image. The wavelet transformation is defined by a inner product
* (ie. convolution-like operation).
*
* the inner operator are supposed to be defined through 1D filters. Then, the
- * forward transformation yields \f$ 2^{\test{Dim}} \f$ output images, while the inverse
+ * forward transformation yields \f$ 2^{Dim} \f$ output images, while the inverse
* transformation requires \f$ 2^{\text{Dim}} \f$ input image for one output.
*
* In case of 1D, GetOutput(0) -> LowPass
@@ -67,15 +67,15 @@ namespace otb {
* Dim (n-1) Dim (n-2) Dim (n-3) ... Dim 1 Dim 0
*
* -> x_(n-1) x_(n-2) x_(n-3) x_1 x_0
- *
+ *
* And conversely in the inverse transformation.
*
- * TODO: At present version, there is not consideration on meta data information that can be transmited
+ * \todo: At present version, there is not consideration on meta data information that can be transmited
* from the input(s) to the output(s)...
*
* At this step, it would have been interesting to implements a DirectionalInnerProductImageFilter to synchronize
* the pipeline through a composite filter
- *
+ *
* The two choice (FORWARD/INVERSE) yield specific implementation of the templates (header redeclaration
* is given at bottom of of otbFilterBank.h
*
@@ -86,8 +86,8 @@ namespace otb {
*
* \ingroup Streamed
*/
-template < class TInputImage, class TOutputImage,
- class TLowPassOperator, class THighPassOperator,
+template < class TInputImage, class TOutputImage,
+ class TLowPassOperator, class THighPassOperator,
InverseOrForwardTransformationEnum TDirectionOfTransformation >
class ITK_EXPORT WaveletFilterBank
: public itk::ImageToImageFilter< TInputImage, TOutputImage >
@@ -137,7 +137,7 @@ public:
itkSetMacro(UpSampleFilterFactor,unsigned int);
/**
- * Set/Get the level of down sampling of the image used in forward algorithm.
+ * Set/Get the level of down sampling of the image used in forward algorithm.
* (or upsampling in the inverse case)
*
* In this implementation, we are dealing with M-band decomposition then m_SubsampleImageFactor
@@ -154,13 +154,13 @@ private:
WaveletFilterBank( const Self & );
void operator=( const Self & );
}; // end of class
-
+
/** \class FilterBank
* \brief Template specialization of FilterBank for forward transformaiton
*/
-template < class TInputImage, class TOutputImage,
+template < class TInputImage, class TOutputImage,
class TLowPassOperator, class THighPassOperator >
- class ITK_EXPORT WaveletFilterBank< TInputImage, TOutputImage,
+ class ITK_EXPORT WaveletFilterBank< TInputImage, TOutputImage,
TLowPassOperator, THighPassOperator, FORWARD >
: public itk::ImageToImageFilter< TInputImage, TOutputImage >
{
@@ -209,7 +209,7 @@ public:
itkSetMacro(UpSampleFilterFactor,unsigned int);
/**
- * Set/Get the level of down sampling of the image used in forward algorithm.
+ * Set/Get the level of down sampling of the image used in forward algorithm.
* (or upsampling in the inverse case)
*
* In this implementation, we are dealing with M-band decomposition then m_SubsampleImageFactor
@@ -222,7 +222,7 @@ protected:
WaveletFilterBank();
virtual ~WaveletFilterBank() {}
- /** GenerateOutputInformation
+ /** GenerateOutputInformation
* Set the size of the output image depending on the decimation factor
* Copy informations from the input image if existing.
**/
@@ -234,9 +234,9 @@ protected:
*/
virtual void BeforeThreadedGenerateData ();
- /** Internal Data Allocation
+ /** Internal Data Allocation
* If m_SubsampleImageFactor != 1, internal data with progressive region size
- * subsampling if required...
+ * subsampling if required...
*/
virtual void AllocateInternalData ( const OutputImageRegionType& outputRegion );
@@ -246,29 +246,29 @@ protected:
virtual void AfterThreadedGenerateData ();
/** CallCopyOutputRegionToInputRegion
- * Since input and output image may be of different size when a
- * subsampling factor has tp be applied, Region estimation
+ * Since input and output image may be of different size when a
+ * subsampling factor has tp be applied, Region estimation
* functions has to be reimplemented
*/
- virtual void CallCopyOutputRegionToInputRegion
+ virtual void CallCopyOutputRegionToInputRegion
( InputImageRegionType & destRegion, const OutputImageRegionType & srcRegion );
virtual void CallCopyInputRegionToOutputRegion
- ( OutputImageRegionType & destRegion, const InputImageRegionType & srcRegion );
+ ( OutputImageRegionType & destRegion, const InputImageRegionType & srcRegion );
/** CallCopyOutputRegionToInputRegion
- * This function is also redefined in order to adapt the shape of the regions with
+ * This function is also redefined in order to adapt the shape of the regions with
* resect to the direction (among the dimensions) of the filtering.
*/
virtual void CallCopyOutputRegionToInputRegion ( unsigned int direction,
InputImageRegionType & destRegion, const OutputImageRegionType & srcRegion );
- virtual void CallCopyInputRegionToOutputRegion ( unsigned int direction,
+ virtual void CallCopyInputRegionToOutputRegion ( unsigned int direction,
OutputImageRegionType & destRegion, const InputImageRegionType & srcRegion );
/** Generate data redefinition */
virtual void ThreadedGenerateData ( const OutputImageRegionType& outputRegionForThread, int threadId );
/** Iterative call to the forward filter bank at each dimension. */
- virtual void ThreadedGenerateDataAtDimensionN ( unsigned int idx, unsigned int direction,
+ virtual void ThreadedGenerateDataAtDimensionN ( unsigned int idx, unsigned int direction,
itk::ProgressReporter & reporter,
const OutputImageRegionType& outputRegionForThread, int threadId );
@@ -280,20 +280,20 @@ private:
unsigned int m_SubsampleImageFactor;
/** the easiest way to store internal images is to keep track of the splits
- * at each direction. Then, std::vector< InternalImagesTabular > is a tab of
- * size ImageDimension-1 and each InternalImagesTabular contains intermediate
+ * at each direction. Then, std::vector< InternalImagesTabular > is a tab of
+ * size ImageDimension-1 and each InternalImagesTabular contains intermediate
* images
*/
typedef std::vector< OutputImagePointerType > InternalImagesTabular;
std::vector< InternalImagesTabular > m_InternalImages;
}; // end of class
-
+
#if 0
/** \class FilterBank
* \brief Template specialization of FilterBank for inverse transformation
*/
-template < class TInputImage, class TOutputImage,
+template < class TInputImage, class TOutputImage,
class TLowPassOperator, class THighPassOperator >
class ITK_EXPORT WaveletFilterBank< TInputImage, TOutputImage, TLowPassOperator, THighPassOperator, INVERSE >
: public itk::ImageToImageFilter< TInputImage, TOutputImage >
@@ -343,7 +343,7 @@ public:
itkSetMacro(UpSampleFilterFactor,unsigned int);
/**
- * Set/Get the level of down sampling of the image used in forward algorithm.
+ * Set/Get the level of down sampling of the image used in forward algorithm.
* (or upsampling in the inverse case)
*
* In this implementation, we are dealing with M-band decomposition then m_SubsampleImageFactor
@@ -357,21 +357,21 @@ protected:
WaveletFilterBank();
virtual ~WaveletFilterBank();
- /** GenerateOutputInformation
+ /** GenerateOutputInformation
* Set the size of the output image depending on the decimation factor
* Copy informations from the input image if existing.
**/
virtual void GenerateOutputInformation();
/** CallCopyOutputRegionToInputRegion
- * Since input and output image may be of different size when a
- * subsampling factor has tp be applied, Region estimation
+ * Since input and output image may be of different size when a
+ * subsampling factor has tp be applied, Region estimation
* functions has to be reimplemented
*/
- virtual void CallCopyOutputRegionToInputRegion
+ virtual void CallCopyOutputRegionToInputRegion
( InputImageRegionType & destRegion, const OutputImageRegionType & srcRegion );
virtual void CallCopyInputRegionToOutputRegion
- ( OutputImageRegionType & destRegion, const InputImageRegionType & srcRegion );
+ ( OutputImageRegionType & destRegion, const InputImageRegionType & srcRegion );
virtual void EnlargeRegion ( InputImageRegionType & destRegion, const OutputImageRegionType & srcRegion );
virtual void ReduceRegion ( InputImageRegionType & destRegion, const OutputImageRegionType & srcRegion );
@@ -385,11 +385,11 @@ protected:
virtual void ThreadedGenerateData ( const OutputImageRegionType& outputRegionForThread, int threadId );
/** Iterative call to the inverse filter bank at each dimension */
- virtual void ThreadedGenerateData ( unsigned int idx, unsigned int direction,
+ virtual void ThreadedGenerateData ( unsigned int idx, unsigned int direction,
InputImagePointerType & outputImage,
itk::ProgressReporter & reporter,
const InputImageRegionType& inputRegionForThread, int threadId );
-
+
/** Specific case applied on the last reconstruction in inverse transformation */
virtual void ThreadedGenerateData ( itk::ProgressReporter & reporter,
const OutputImageRegionType& outputRegionForThread, int threadId );
@@ -398,7 +398,7 @@ protected:
typedef itk::ConstNeighborhoodIterator< InputImageType > NeighborhoodIteratorType;
typedef itk::NeighborhoodInnerProduct< InputImageType > InnerProductType;
typedef itk::ImageRegionIterator< InputImageType > IteratorType;
- typedef typename itk::NeighborhoodAlgorithm
+ typedef typename itk::NeighborhoodAlgorithm
::ImageBoundaryFacesCalculator< InputImageType > FaceCalculatorType;
typedef typename FaceCalculatorType::FaceListType FaceListType;
typedef typename FaceListType::iterator FaceListIterator;
@@ -421,7 +421,7 @@ private:
}; // end of class
#endif // Dbg
-
+
} // end of namespace otb
#ifndef OTB_MANUAL_INSTANTIATION
--
GitLab