Skip to content
Snippets Groups Projects
Commit e9aafe60 authored by Emmanuel Christophe's avatar Emmanuel Christophe
Browse files

DOC: fix doxygen errors

parent 07c6de6f
No related branches found
No related tags found
No related merge requests found
...@@ -32,12 +32,12 @@ namespace otb { ...@@ -32,12 +32,12 @@ namespace otb {
* This is appropriated to perform simple outlier detection over vector data. * This is appropriated to perform simple outlier detection over vector data.
* The input image has to contain vector pixel through a VectorImage type. * The input image has to contain vector pixel through a VectorImage type.
* When an outlier is detected, it is treated to as an missing value through the function * When an outlier is detected, it is treated to as an missing value through the function
* \code{otb::EuclideanDistanceWithMissingValue::SetToMissingValue()}. * \code otb::EuclideanDistanceWithMissingValue::SetToMissingValue() \endcode.
* *
* A component is considered to as a missing value when * A component is considered to as a missing value when
* \f$ \| x_i - \beta \left( x_{3/4} - x_{1/4} \right) \| > \| x_{1/2} \| \f$ * \f$ \| x_i - \beta \left( x_{3/4} - x_{1/4} \right) \| > \| x_{1/2} \| \f$
* where \f$ x_{1/4}, x_{1/2}, x_{3/4} \f$ stand for the first, second (median) and * where \f$ x_{1/4}, x_{1/2}, x_{3/4} \f$ stand for the first, second (median) and
* thrid quantile values. * third quantile values.
* *
* \ingroup Streamed * \ingroup Streamed
* \sa EuclideanDistanceWithMissingValue * \sa EuclideanDistanceWithMissingValue
...@@ -83,7 +83,7 @@ class ITK_EXPORT BoxAndWhiskerImageFilter ...@@ -83,7 +83,7 @@ class ITK_EXPORT BoxAndWhiskerImageFilter
/** Get the Radius (all to 1) */ /** Get the Radius (all to 1) */
itkGetConstReferenceMacro(Radius, SizeType); itkGetConstReferenceMacro(Radius, SizeType);
/** Fix the \em whisker */ /** Fix the whisker */
itkGetConstMacro(Beta,double); itkGetConstMacro(Beta,double);
itkSetMacro(Beta,double); itkSetMacro(Beta,double);
itkGetConstMacro(NumberFound,unsigned int); itkGetConstMacro(NumberFound,unsigned int);
......
...@@ -36,7 +36,7 @@ namespace Statistics { ...@@ -36,7 +36,7 @@ namespace Statistics {
* The class can be templated over any container that holds data elements, as * The class can be templated over any container that holds data elements, as
* for template of EuclideanDistance. * for template of EuclideanDistance.
* *
* The only restriction is that elemnts have to support '\code{NaN}'. * The only restriction is that elements have to support NaN values.
* *
* \sa EuclideanDistance * \sa EuclideanDistance
* \sa EuclideanDistanceWithMissingValuePow2 * \sa EuclideanDistanceWithMissingValuePow2
......
...@@ -32,13 +32,13 @@ namespace Statistics { ...@@ -32,13 +32,13 @@ namespace Statistics {
* *
* This class is derived from EuclideanDistance class. In addition * This class is derived from EuclideanDistance class. In addition
* to the initial Evaluate method, the class does not perform calculation * to the initial Evaluate method, the class does not perform calculation
* when a component does not contain any data. The 'no data' case is perform through the \code{SetToMissingValue()} * when a component does not contain any data. The 'no data' case is perform through the \code SetToMissingValue() \endcode
* which performs a \code{Nan} affectation. * which performs a \code Nan \endcode affectation.
* *
* The class can be templated over any container that holds data elements, as * The class can be templated over any container that holds data elements, as
* for template of EuclideanDistance. * for template of EuclideanDistance.
* *
* The only restriction is that elemnts have to support '\code{NaN}'. * The only restriction is that elements have to support NaN values.
* *
* \sa EuclideanDistance * \sa EuclideanDistance
* \sa EuclideanDistanceWithMissingValue * \sa EuclideanDistanceWithMissingValue
......
...@@ -42,7 +42,7 @@ namespace Statistics { ...@@ -42,7 +42,7 @@ namespace Statistics {
* The class can be templated over any container that holds data elements, as * The class can be templated over any container that holds data elements, as
* for template of EuclideanDistance. * for template of EuclideanDistance.
* *
* The only restriction is that elements have to support '\code{NaN}'. * The only restriction is that elements have to support \code NaN \endcode.
* *
* \sa EuclideanDistanceWithMissingValuePow2 * \sa EuclideanDistanceWithMissingValuePow2
*/ */
......
...@@ -134,7 +134,7 @@ template <class TVectorData, class TImage> ...@@ -134,7 +134,7 @@ template <class TVectorData, class TImage>
*/ */
itkSetMacro(UseAsOverlay, bool); itkSetMacro(UseAsOverlay, bool);
itkGetMacro(UseAsOverlay, bool); itkGetMacro(UseAsOverlay, bool);
itkBooleanMacro(UseAsOverlay) itkBooleanMacro(UseAsOverlay);
protected: protected:
/** Constructor */ /** Constructor */
...@@ -191,4 +191,4 @@ template <class TVectorData, class TImage> ...@@ -191,4 +191,4 @@ template <class TVectorData, class TImage>
#include "otbVectorDataToImageFilter.txx" #include "otbVectorDataToImageFilter.txx"
#endif #endif
#endif #endif
\ No newline at end of file
...@@ -85,7 +85,7 @@ private: ...@@ -85,7 +85,7 @@ private:
void operator= ( const Self & ); void operator= ( const Self & );
}; };
/** \class Wavelet Packet Transform /** \class WaveletPacketTransform
* \brief Wavelet packet forward transformation framework * \brief Wavelet packet forward transformation framework
* *
* This class defines the Wavelet Packet transformation of an image * This class defines the Wavelet Packet transformation of an image
...@@ -215,7 +215,7 @@ private: ...@@ -215,7 +215,7 @@ private:
}; // end of class }; // end of class
/** \class Wavelet Packet Transform /** \class WaveletPacketTransform
* \brief Wavelet packet inverse transformation framework * \brief Wavelet packet inverse transformation framework
* *
* This class defines the Wavelet Packet transformation of an image * This class defines the Wavelet Packet transformation of an image
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment