Commit 44192b38 authored by Aurélien Bricier's avatar Aurélien Bricier

DOC: enhanced class documentation and clean comments

parent b37f15df
......@@ -29,17 +29,16 @@
namespace otb
{
/** \class VectorDataToRoadDescriptionFilter
* \brief VectorDataToRoadDescriptionFilter associates scores to each
* \brief VectorDataToRoadDescriptionFilter associates a score to each
* adapted input VectorData DataNode.
*
* VectorDataToRoadDescriptionFilter is dedicated to road description.
* Input and output are both VectorDatas in index coordinate.
* Each DataNode of the
* output VectorData contains its scores regarding to the associated
* descriptors.
* Each DataNode of the output VectorData contains its scores
* regarding to the associated descriptors.
* The support is an Optical Image and the descriptor are:
* -
*
* - (NDVI >= threshold) per cent along the tested lines
* - mean Spectral Angle regarding a reference pixel along the tested lines
*
* \ingroup VectorDataFilter
* \sa VectorDataToSpecificDescriptionFilterBase
......@@ -88,13 +87,7 @@ public:
virtual void AddOpticalImage(const OpticalImageType * support);
const OpticalImageType * GetOpticalImage();
/*
virtual void AddNDVIImage(const NDVIImageType * support);
const NDVIImageType * GetNDVIImage();
virtual void AddLSDVectorData(const VectorDataType * support);
const VectorDataType * GetLSDVectorData();
*/
protected:
/** Constructor */
VectorDataToRoadDescriptionFilter();
......
......@@ -50,43 +50,7 @@ VectorDataToRoadDescriptionFilter<TVectorData, TOpticalImage, TNDVIImage>
return static_cast<const OpticalImageType *>
(this->GetSupport(0));
}
/*
template <class TVectorData, class TOpticalImage, class TNDVIImage>
void
VectorDataToRoadDescriptionFilter<TVectorData, TOpticalImage, TNDVIImage>
::AddNDVIImage(const NDVIImageType * support)
{
this->AddSupport(const_cast<NDVIImageType *>(support), 1);
}
template <class TVectorData, class TOpticalImage, class TNDVIImage>
const typename VectorDataToRoadDescriptionFilter<TVectorData, TOpticalImage, TNDVIImage>
::NDVIImageType *
VectorDataToRoadDescriptionFilter<TVectorData, TOpticalImage, TNDVIImage>
::GetNDVIImage()
{
return static_cast<const NDVIImageType *>
(this->GetSupport(1));
}
template <class TVectorData, class TOpticalImage, class TNDVIImage>
void
VectorDataToRoadDescriptionFilter<TVectorData, TOpticalImage, TNDVIImage>
::AddLSDVectorData(const VectorDataType * support)
{
this->AddSupport(const_cast<VectorDataType *>(support), 2);
}
template <class TVectorData, class TOpticalImage, class TNDVIImage>
const typename VectorDataToRoadDescriptionFilter<TVectorData, TOpticalImage, TNDVIImage>
::VectorDataType *
VectorDataToRoadDescriptionFilter<TVectorData, TOpticalImage, TNDVIImage>
::GetLSDVectorData()
{
return static_cast<const VectorDataType *>
(this->GetSupport(2));
}
*/
template <class TVectorData, class TOpticalImage, class TNDVIImage>
void
VectorDataToRoadDescriptionFilter<TVectorData, TOpticalImage, TNDVIImage>
......
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