Commit f3bdece4 authored by Emmanuel Christophe's avatar Emmanuel Christophe
Browse files

DOC: mark some classes (wavelet, vector data rendering) as experimental for the doxygen

parent 7661fed4
......@@ -27,9 +27,12 @@
namespace otb
{
/** \class VectorDataToImageFilter
* \brief Render a vector data into an image
* \brief <b>EXPERIMENTAL FEATURE</b> Render a vector data into an image
*
*/
* To use this class, you need to compile the library with the option OTB_USE_MAPNIK
* to ON. You also need to install mapnik on your machine (http://www.mapnik.org)
*
*/
template <class TVectorData, class TImage>
......
......@@ -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.
=========================================================================*/
......@@ -27,11 +27,11 @@ namespace otb {
/**
* \class LowPassHaarOperator
*
* \brief A NeighborhoodOperator for performing a Haar based filtering
* \brief <b>EXPERIMENTAL FEATURE</b> A NeighborhoodOperator for performing a Haar based filtering
* at a pixel location.
*
* LowPassHaarOperator is a NeighborhoodOperator that should be applied to a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
*
* LowPassHaarOperator is a NeighborhoodOperator that should be applied to a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
* The Haar Operator is defiend in 1D as \f$ H(z) = ( 1 + z^{-1} ) / 2 \f$.
* In N dimensions, the operator is directional
*
......@@ -40,7 +40,7 @@ namespace otb {
* \sa Neighborhood
* \sa ForwardDifferenceOperator
* \sa BackwardDifferenceOperator
*
*
* \ingroup Operators
*/
template < InverseOrForwardTransformationEnum TDirectionOfTransformation,
......@@ -55,11 +55,11 @@ public:
typedef WaveletOperator<TPixel, VDimension, TAllocator> Superclass;
itkTypeMacro(LowPassHaarOperator, WaveletOperator);
typedef InverseOrForwardTransformationEnum DirectionOfTransformationEnumType;
itkStaticConstMacro(DirectionOfTransformation,DirectionOfTransformationEnumType,TDirectionOfTransformation);
LowPassHaarOperator()
LowPassHaarOperator()
{
this->SetRadius(1);
this->CreateToRadius(1);
......@@ -67,7 +67,7 @@ public:
}
LowPassHaarOperator(const Self& other)
: WaveletOperator<TPixel, VDimension, TAllocator>(other)
: WaveletOperator<TPixel, VDimension, TAllocator>(other)
{
this->SetWavelet( "Haar" );
}
......@@ -83,8 +83,8 @@ public:
/**
* Prints some debugging information
*/
virtual void PrintSelf(std::ostream &os, itk::Indent i) const
{
virtual void PrintSelf(std::ostream &os, itk::Indent i) const
{
Superclass::PrintSelf(os, i.GetNextIndent());
os << i << "LowPassHaarOperator {this=" << this << "}" << std::endl;
}
......@@ -104,11 +104,11 @@ protected:
{
CoefficientVector coeff;
// stands for z^{-1}
coeff.push_back(0.5);
coeff.push_back(0.5);
// stands for z^0
coeff.push_back(0.5);
// stands for z^1
coeff.push_back(0.0);
coeff.push_back(0.0);
#if 0
std::cerr << "Coeff H(" << this->GetWavelet();
......@@ -126,8 +126,8 @@ protected:
/** Arranges coefficients spatially in the memory buffer. */
void Fill(const CoefficientVector& coeff)
{
this->FillCenteredDirectional(coeff);
{
this->FillCenteredDirectional(coeff);
}
};
......@@ -136,9 +136,9 @@ protected:
*
* \brief A NeighborhoodOperator for performing a Haar based filtering
* at a pixel location.
*
* HighPassHaarOperator is a NeighborhoodOperator that should be applied a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
*
* HighPassHaarOperator is a NeighborhoodOperator that should be applied a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
* The Haar Operator is defiend in 1D as \f$ G(z) = ( 1 - z^{-1} ) / 2 \f$.
* In N dimensions, the operator is directional
*
......@@ -147,7 +147,7 @@ protected:
* \sa Neighborhood
* \sa ForwardDifferenceOperator
* \sa BackwardDifferenceOperator
*
*
* \ingroup Operators
*/
template< InverseOrForwardTransformationEnum TDirectionOfTransformation,
......@@ -162,11 +162,11 @@ public:
typedef WaveletOperator<TPixel, VDimension, TAllocator> Superclass;
itkTypeMacro(HighPassHaarOperator, WaveletOperator);
typedef InverseOrForwardTransformationEnum DirectionOfTransformationEnumType;
itkStaticConstMacro(DirectionOfTransformation,DirectionOfTransformationEnumType,TDirectionOfTransformation);
HighPassHaarOperator()
HighPassHaarOperator()
{
this->SetRadius(1);
this->CreateToRadius(1);
......@@ -174,7 +174,7 @@ public:
}
HighPassHaarOperator(const Self& other)
: WaveletOperator<TPixel, VDimension, TAllocator>(other)
: WaveletOperator<TPixel, VDimension, TAllocator>(other)
{
this->SetWavelet( "Haar" );
}
......@@ -190,8 +190,8 @@ public:
/**
* Prints some debugging information
*/
virtual void PrintSelf(std::ostream &os, itk::Indent i) const
{
virtual void PrintSelf(std::ostream &os, itk::Indent i) const
{
Superclass::PrintSelf(os, i.GetNextIndent());
os << i << "HighPassHaarOperator {this=" << this << "}" << std::endl;
}
......@@ -225,7 +225,7 @@ protected:
for ( typename LowPassOperatorType::ConstIterator iter = lowPassOperator.Begin();
iter != lowPassOperator.End(); ++iter )
lowPassCoeff.push_back( *iter );
switch ( DirectionOfTransformation )
{
case FORWARD:
......@@ -255,8 +255,8 @@ protected:
/** Arranges coefficients spatially in the memory buffer. */
void Fill(const CoefficientVector& coeff)
{
this->FillCenteredDirectional(coeff);
{
this->FillCenteredDirectional(coeff);
}
};
......
......@@ -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.
=========================================================================*/
......@@ -30,15 +30,15 @@ namespace otb {
/**
* \class LowPassSplineBiOrthogonalOperator
*
* \brief A NeighborhoodOperator for performing a Spline Bi-Orthogonal-based filtering
* \brief <b>EXPERIMENTAL FEATURE</b> A NeighborhoodOperator for performing a Spline Bi-Orthogonal-based filtering
* at a pixel location.
*
* It may be configure with many filter orders. AT present time, so-called "9/7" filter is
* It may be configure with many filter orders. AT present time, so-called "9/7" filter is
* implemented. It may be fixed with SetWavelet method
*
* The LowPassSplineBiOrthogonalOperator is a NeighborhoodOperator that should be applied a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
* The 9/7 Operator is defiend in 1D as
*
* The LowPassSplineBiOrthogonalOperator is a NeighborhoodOperator that should be applied a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
* The 9/7 Operator is defiend in 1D as
* \f$ H(z) = 0.026748757411 z^{-4} -0.016864118443 z^{-3} -0.078223266529 z^{-2}
* + 0.266864118443 z^{-1} + 0.602949018236 + 0.266864118443 z
* -0.078223266529 z^2 -0.016864118443 z^3 + 0.026748757411 z^4 \f$.
......@@ -50,7 +50,7 @@ namespace otb {
* \sa Neighborhood
* \sa ForwardDifferenceOperator
* \sa BackwardDifferenceOperator
*
*
* \ingroup Operators
*/
template < InverseOrForwardTransformationEnum TDirectionOfTransformation,
......@@ -80,7 +80,7 @@ public:
/**
* Prints some debugging information
*/
virtual void PrintSelf(std::ostream &os, itk::Indent i) const;
virtual void PrintSelf(std::ostream &os, itk::Indent i) const;
protected:
/**
......@@ -104,10 +104,10 @@ protected:
*
* \brief A NeighborhoodOperator for performing a Spline Bi-Orthogonal-based filtering
* at a pixel location.
*
* HighPassSplineBiOrthogonalOperator is a NeighborhoodOperator that should be applied a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
* The 9/7 Operator is defiend in 1D as
*
* HighPassSplineBiOrthogonalOperator is a NeighborhoodOperator that should be applied a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
* The 9/7 Operator is defiend in 1D as
* \f$ H(z) = 0.045635881557 z^{-3} -0.028771763114 z^{-2} -0.295635881557 z^{-1}
* + 0.557543526229 - 0.295635881557 z -0.028771763114 z^2 + 0.045635881557 z^3 \f$.
*
......@@ -118,7 +118,7 @@ protected:
* \sa Neighborhood
* \sa ForwardDifferenceOperator
* \sa BackwardDifferenceOperator
*
*
* \ingroup Operators
*/
template < InverseOrForwardTransformationEnum TDirectionOfTransformation,
......@@ -133,7 +133,7 @@ public:
typedef WaveletOperator<TPixel, VDimension, TAllocator> Superclass;
itkTypeMacro(HighPassSplineBiOrthogonalOperator, WaveletOperator);
typedef InverseOrForwardTransformationEnum DirectionOfTransformationEnumType;
itkStaticConstMacro(DirectionOfTransformation,DirectionOfTransformationEnumType,TDirectionOfTransformation);
......
......@@ -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.
=========================================================================*/
......@@ -27,9 +27,9 @@
namespace otb {
/** \class FullyDecomposedWaveletPacketCost
* \brief Cost evaluation to be used into the Wavelet Packet decomposition class.
* \brief <b>EXPERIMENTAL FEATURE</b> Cost evaluation to be used into the Wavelet Packet decomposition class.
*
* This class implements the criteria to perform fully decomposed wavelet packet.
* This class implements the criteria to perform fully decomposed wavelet packet.
* It is based on the depth of the decomposition only...
*
* \sa WaveletPacketForwardTransform
......@@ -75,7 +75,7 @@ private:
FullyDecomposedWaveletPacketCost ( const Self & ); // not implemented
void operator= ( const Self & );
}; // end of class
}; // end of class
} // end of namespace otb
......
......@@ -35,7 +35,7 @@
namespace otb {
/** \class WaveletFilterBank
* \brief One level stationary wavelet transform
* \brief <b>EXPERIMENTAL FEATURE</b> 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
......
......@@ -27,7 +27,7 @@
namespace otb {
/** \class WaveletForwardTransform
* \brief Wavelet transformation framework
* \brief <b>EXPERIMENTAL FEATURE</b> Wavelet transformation framework
*
* This class defines the Wavelet Packet transformation of an image
* by using a (templated) elementary wavelet transform.
......
......@@ -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.
=========================================================================*/
......@@ -31,23 +31,23 @@ namespace otb {
/**
* \class WaveletOperator
*
* \brief A NeighborhoodOperator wavelet base class
* \brief <b>EXPERIMENTAL FEATURE</b> A NeighborhoodOperator wavelet base class
*
* This class is the mother class for any wavelet operator that requires
* "a-trou" approach for shift-invariant wavelet transform. This class has
* "a-trou" approach for shift-invariant wavelet transform. This class has
* to be derived, it cannot be used directly.
*
* Any wavelet operator that inherits from WaveletOperator is to be used
* as a NeighborhoodOperator that should be applied to a
* as a NeighborhoodOperator that should be applied to a
* NeighborhoodIterator using the NeighborhoodInnerProduct method.
*
* It is assumed that any wavelet is directional.
*
* Set the level of up-sampling though SetUpSampleFactor() before calling
* CreateDirectional(). Each class that inherits from WaveletOperator has
* Set the level of up-sampling though SetUpSampleFactor() before calling
* CreateDirectional(). Each class that inherits from WaveletOperator has
* to re-implement GenerateCoefficients(). It has to end by:
* return this->UpSamplingCoefficients( coeff ) to perform the up-sampling
*
*
* \sa LowPassHaarOperator
* \sa HighPassHaarOperator
* \sa NeighborhoodOperator
......@@ -73,7 +73,7 @@ public:
{ }
/** Construction by copy */
WaveletOperator( const Self & other )
WaveletOperator( const Self & other )
: itk::NeighborhoodOperator<TPixel, VDimension, TAllocator> (other)
{
m_UpSampleFactor = other.GetUpSampleFactor();
......@@ -92,8 +92,8 @@ public:
/**
* Prints some debugging information
*/
virtual void PrintSelf(std::ostream &os, itk::Indent i) const
{
virtual void PrintSelf(std::ostream &os, itk::Indent i) const
{
Superclass::PrintSelf(os, i.GetNextIndent());
os << i << "Up-Sampling factor " << this->m_UpSampleFactor << "\n";
os << i << "Wavelet kind : " << GetWavelet() << std::endl;
......@@ -102,7 +102,7 @@ public:
/**
* Set/Get the level of up sampling of the filter
*/
unsigned int GetUpSampleFactor () const
unsigned int GetUpSampleFactor () const
{
return this->m_UpSampleFactor;
}
......@@ -132,11 +132,11 @@ protected:
typedef typename Superclass::CoefficientVector CoefficientVector;
typedef typename Superclass::PixelType PixelType;
/**
/**
* Perform the "a-trou" algorithm for shift-invariant transformation.
* It transforms the filter \f$ H(z) \f$ into \f$ H(z^2) \f$.
*/
CoefficientVector UpSamplingCoefficients ( CoefficientVector & coeff )
CoefficientVector UpSamplingCoefficients ( CoefficientVector & coeff )
{
if ( m_UpSampleFactor == 0 )
return coeff;
......@@ -160,12 +160,12 @@ protected:
return coeff;
}
/**
/**
* Performs the definition of synthesis filter from analysis one.
* Input is the forward low pass filter coefficients.
* It performs \f$ {\tilde G}(z) = -H(-z) \f$.
*/
CoefficientVector GetInverseHighPassFilterFromForwardLowPassFilter ( CoefficientVector & coeff )
CoefficientVector GetInverseHighPassFilterFromForwardLowPassFilter ( CoefficientVector & coeff )
{
unsigned long radius = static_cast<unsigned long>( coeff.size() );
this->SetRadius( radius );
......@@ -185,12 +185,12 @@ protected:
return coeff;
}
/**
/**
* Performs the definition of synthesis filter from analysis one.
* Input is the forward high pass filter coefficients.
* It performs \f$ {\tilde H}(z) = G(-z) \f$.
*/
CoefficientVector GetInverseLowPassFilterFromForwardHighPassFilter ( CoefficientVector & coeff )
CoefficientVector GetInverseLowPassFilterFromForwardHighPassFilter ( CoefficientVector & coeff )
{
unsigned long radius = static_cast<unsigned long>( coeff.size() );
this->SetRadius( radius );
......@@ -210,14 +210,14 @@ protected:
return coeff;
}
/**
/**
* Performs the definition of high pass filter from the low pass one
* in a Quadrature mirror filter bank framework. It is then valid to
* define high pass filters from orthogonal wavelets...
* Input is the forward low pass filter coefficients.
* It performs \f$ G(z) = H(-z) \f$.
*/
CoefficientVector GetHighPassFilterFromLowPassFilter ( CoefficientVector & coeff )
CoefficientVector GetHighPassFilterFromLowPassFilter ( CoefficientVector & coeff )
{
unsigned long radius = static_cast<unsigned long>( coeff.size() );
this->SetRadius( radius );
......
......@@ -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.
=========================================================================*/
......@@ -26,7 +26,7 @@
namespace otb {
/** \class WaveletPacketForwardTransform
* \brief Wavelet packet transformation framework
* \brief <b>EXPERIMENTAL FEATURE</b> Wavelet packet transformation framework
*
* This class defines the Wavelet Packet transformation of an image
* by using a (templated) elementary wavelet transform and (templated)
......@@ -34,12 +34,12 @@ namespace otb {
*
* It yields a list of images...
*
* TODO: this class implements the decomposition only. But there is no storage
* TODO: this class implements the decomposition only. But there is no storage
* of the way of decomposition. It should be added before implementing backward
* transformation.
*
* the user is supposed to initialize Cost properly (through GetCost() macro)
* depending on its type before calling an Update(). The Cost class has to contain
* the user is supposed to initialize Cost properly (through GetCost() macro)
* depending on its type before calling an Update(). The Cost class has to contain
* a New() and Evaluate() function.
*
* \sa FullyDecomposedWaveletPacketCost
......@@ -90,7 +90,7 @@ public:
typedef typename CostType::Pointer CostPointerType;
itkGetObjectMacro(Cost,CostType);
itkStaticConstMacro(InputImageDimension, unsigned int,TInputImage::ImageDimension);
protected:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment