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

DOC: Doxygen example to the end of description

parent d22c61e8
......@@ -56,11 +56,12 @@ namespace otb {
* \warning This filter assumes that the fixed image type, moving image type
* and deformation field type all have the same number of dimensions.
*
* \sa NCCRegistrationFunction
* \ingroup DeformableImageRegistration MultiThreaded
*
* \example DisparityMap/NCCRegistrationFilterExample.cxx
*
*
* \sa NCCRegistrationFunction
* \ingroup DeformableImageRegistration MultiThreaded
*/
template<class TFixedImage, class TMovingImage, class TDeformationField>
class ITK_EXPORT NCCRegistrationFilter :
......
......@@ -28,11 +28,13 @@ namespace otb
* A path is considered to be tortuous if the mean distance between each consecutive vertices
* is lower than the user provided threshold.
*
*
* \example FeatureExtraction/ExtractRoadByStepsExample.cxx
*
* \sa BreakAngularPathListFilter
* \sa SimplifyPathFilter
*
*
*
* \example FeatureExtraction/ExtractRoadByStepsExample.cxx
*
*/
template <class TPath>
class ITK_EXPORT RemoveTortuousPathListFilter
......
......@@ -29,10 +29,11 @@ namespace Functor
/** \class RemoveWrongDirectionFunctor
* \brief This functor is used by the RemoveWrongDirectionFilter
*
* \example FeatureExtraction/ExtractRoadByStepsExample.cxx
*
* \sa RemoveWrongDirectionFilter
* \ingroup Functor
*
* \example FeatureExtraction/ExtractRoadByStepsExample.cxx
*
*/
template <class TInput1, class TInput2, class TOutput>
class RemoveWrongDirectionFunctor
......
......@@ -52,11 +52,11 @@ namespace otb
* 1000 \f$ \times \f$ 1000 images with four spectral bands. Results can be
* used as an initialization for more complex algorithms.
*
* \sa SpectralAngleDistanceImageFilter
* \sa GenericRoadExtractionFilter
*
* \example FeatureExtraction/ExtractRoadExample.cxx
*
* \sa SpectralAngleDistanceImageFilter
* \sa GenericRoadExtractionFilter
*/
template <class TInputImage, class TOutputPath>
class ITK_EXPORT RoadExtractionFilter
......
......@@ -39,11 +39,11 @@ namespace otb
*
* This filter is part of the road extraction framework.
*
* \sa BreakAngularPathListFilter
* \sa RemoveTortuousPathFilter.
*
* \example FeatureExtraction/ExtractRoadByStepsExample.cxx
*
* \sa BreakAngularPathListFilter
* \sa RemoveTortuousPathFilter.
*/
template <class TPath>
class ITK_EXPORT SimplifyPathListFilter
......
......@@ -132,9 +132,6 @@ namespace otb
* Bayesian Data Fusion for Adaptable Image Pansharpening,
* Transactions on Geoscience and Remote Sensing,
* vol. 46, n. 6, 2007, pp 1847-1857
*
* \example Fusion/BayesianFusionImageFilter.cxx
*
*
* \sa FusionImageBase
* \sa MatrixTransposeMatrix
......@@ -145,6 +142,10 @@ namespace otb
*
* \ingroup Fusion
*
*
* \example Fusion/BayesianFusionImageFilter.cxx
*
*
*/
......
......@@ -37,12 +37,13 @@ namespace otb {
*
* \f[ \frac{XS}{\mathrm{Filtered}(PAN)} PAN \f]
*
* \example Fusion/PanSharpeningExample.cxx
*
* \ingroup Streamed
* \ingroup Multithreaded
* \ingroup Fusion
*
*
*
* \example Fusion/PanSharpeningExample.cxx
*
**/
template <class TPanImageType,class TXsImageType,class TOutputImageType>
......
......@@ -39,10 +39,11 @@ namespace otb
* This class is based on ossimElevManager. It takes in input the UL and LR geographic coordinates and the spacing.
* Handle DTED and SRTM formats.
*
* \example IO/DEMToImageGenerator.cxx
*
* \ingroup Images
*
*
* \example IO/DEMToImageGenerator.cxx
*
*/
template <class TDEMImage>
class ITK_EXPORT DEMToImageGenerator:
......
......@@ -26,9 +26,10 @@ namespace otb
/** \class SpatialObjectDXFReader
* \brief This class reads the DXF file format to SpatialObjects.
*
* \ingroup ObjectSource
*
* \example IO/DXFReaderExample.cxx
*
* \ingroup ObjectSource
*/
template <class TSpatialObject>
class ITK_EXPORT SpatialObjectDXFReader
......
......@@ -30,6 +30,8 @@ namespace otb
*
* Derived class must reimplement the GetSingleValue() method.
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
template< class TInput1, class TInput2 >
......
......@@ -37,6 +37,8 @@ namespace otb
* - \f$ \Phi \f$ an edge preserving function:
* \f[ \Phi(u) = \frac{u^2}{1+u^2} \f]
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -39,7 +39,9 @@ namespace otb
* with
* - \f$ x_s \f$ the label on site s
* - \f$ y_s \f$ the value on the reference image
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -36,7 +36,9 @@ namespace otb
* - \f$ x_s \f$ the label on site s
* - \f$ y_s \f$ the value on the reference image
* - \f$ \mu_{x_s} \f$ and \f$ \sigma^2_{x_s} \f$ the mean and variance of label \f$ x_s \f$
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -35,7 +35,9 @@ namespace otb
* - \f$ x_s \f$ the label on site s
* - \f$ y_s \f$ the value on the reference image
* - \f$ \sigma^2_{x_s} \f$ the noise variance
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -29,7 +29,9 @@ namespace otb
* \brief This is the base class for optimizer used in the MRF framework.
*
* Derived class must reimplement Compute() method.
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -29,7 +29,9 @@ namespace otb
*
* This is one optimizer to be used in the MRF framework. This optimizer
* follows the ICM algorithm to accept of reject the value proposed by the sampler
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
class ITK_EXPORT MRFOptimizerICM : public MRFOptimizer
......
......@@ -38,6 +38,8 @@ namespace otb
* \f[ e^{\frac{-\Delta E}{T}} \f]
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -30,6 +30,8 @@ namespace otb
* Derived class must reimplement Compute() method.
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -31,6 +31,8 @@ namespace otb
* value which maximizes the apriori probability (minimum energy).
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -32,6 +32,8 @@ namespace otb
* value randomly according to a uniform probability.
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -38,6 +38,8 @@ namespace otb
* where \f$ Z = \sum_x \exp^{-U(x)}\f$
*
*
* This class is meant to be used in the MRF framework with the otb::MarkovRandomFieldFilter
*
* \ingroup Markov
*/
......
......@@ -72,13 +72,14 @@ namespace otb
* markovFilter->SetSampler(sampler);
* \endcode
*
*
* \ingroup Markov
*
* \example Markov/MarkovClassification1Example.cxx
* \example Markov/MarkovClassification2Example.cxx
* \example Markov/MarkovRegularizationExample.cxx
* \example Markov/MarkovRestaurationExample.cxx
*
*
* \ingroup Markov
*/
template <class TInputImage, class TClassifiedImage>
......
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