OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::KMeansAttributesLabelMapFilter< TInputImage > Class Template Reference

#include <otbKMeansAttributesLabelMapFilter.h>

+ Inheritance diagram for otb::KMeansAttributesLabelMapFilter< TInputImage >:
+ Collaboration diagram for otb::KMeansAttributesLabelMapFilter< TInputImage >:

Public Types

typedef LabelObjectType::AttributesValueType AttributesValueType
 
typedef std::vector< VectorTypeCentroidsVectorType
 
typedef LabelObjectType::ClassLabelType ClassLabelType
 
typedef itk::FixedArray< ClassLabelType, 1 > ClassLabelVectorType
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef DataObjectType::Pointer DataObjectPointerType
 
typedef itk::DataObject DataObjectType
 
typedef itk::Statistics::EuclideanDistanceMetric< VectorTypeDistanceType
 
typedef itk::Statistics::KdTreeBasedKmeansEstimator< TreeTypeEstimatorType
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef otb::LabelMapWithClassLabelToLabeledSampleListFilter< InputImageType, ListSampleType, TrainingListSampleTypeLabelMapToSampleListFilterType
 
typedef InputImageType::LabelObjectType LabelObjectType
 
typedef itk::Statistics::ListSample< VectorTypeListSampleType
 
typedef LabelMapToSampleListFilterType::MeasurementFunctorType MeasurementFunctorType
 
typedef itk::SmartPointer< SelfPointer
 
typedef KMeansAttributesLabelMapFilter Self
 
typedef itk::LabelMapFilter< TInputImage, TInputImage > Superclass
 
typedef itk::Statistics::ListSample< ClassLabelVectorTypeTrainingListSampleType
 
typedef itk::Statistics::WeightedCentroidKdTreeGenerator< ListSampleTypeTreeGeneratorType
 
typedef TreeGeneratorType::KdTreeType TreeType
 
typedef itk::VariableLengthVector< AttributesValueTypeVectorType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
InputImagePointer m_InputLabelMap
 
CentroidsVectorType m_Centroids
 
LabelMapToSampleListFilterType::Pointer m_LabelMapToSampleListFilter
 
unsigned int m_NumberOfClasses
 
CentroidsVectorTypeGetCentroids ()
 
const CentroidsVectorTypeGetCentroids () const
 
virtual void SetInputLabelMap (InputImageType *_arg)
 
 itkGetObjectMacro (InputLabelMap, InputImageType)
 
virtual void SetNumberOfClasses (unsigned int _arg)
 
virtual unsigned int GetNumberOfClasses ()
 
MeasurementFunctorTypeGetMeasurementFunctor ()
 
void SetMeasurementFunctor (MeasurementFunctorType &functor)
 
void Compute ()
 
 KMeansAttributesLabelMapFilter ()
 
 ~KMeansAttributesLabelMapFilter () override
 
 KMeansAttributesLabelMapFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage>
class otb::KMeansAttributesLabelMapFilter< TInputImage >

Execute a KMeans on the attributes of a itk::LabelMap<otb::AttributesMapLabelObject>

Definition at line 39 of file otbKMeansAttributesLabelMapFilter.h.

Member Typedef Documentation

◆ AttributesValueType

template<class TInputImage >
typedef LabelObjectType::AttributesValueType otb::KMeansAttributesLabelMapFilter< TInputImage >::AttributesValueType

Definition at line 59 of file otbKMeansAttributesLabelMapFilter.h.

◆ CentroidsVectorType

template<class TInputImage >
typedef std::vector<VectorType> otb::KMeansAttributesLabelMapFilter< TInputImage >::CentroidsVectorType

Definition at line 76 of file otbKMeansAttributesLabelMapFilter.h.

◆ ClassLabelType

template<class TInputImage >
typedef LabelObjectType::ClassLabelType otb::KMeansAttributesLabelMapFilter< TInputImage >::ClassLabelType

Definition at line 60 of file otbKMeansAttributesLabelMapFilter.h.

◆ ClassLabelVectorType

template<class TInputImage >
typedef itk::FixedArray<ClassLabelType, 1> otb::KMeansAttributesLabelMapFilter< TInputImage >::ClassLabelVectorType

Definition at line 64 of file otbKMeansAttributesLabelMapFilter.h.

◆ ConstPointer

template<class TInputImage >
typedef itk::SmartPointer<const Self> otb::KMeansAttributesLabelMapFilter< TInputImage >::ConstPointer

Definition at line 46 of file otbKMeansAttributesLabelMapFilter.h.

◆ DataObjectPointerType

template<class TInputImage >
typedef DataObjectType::Pointer otb::KMeansAttributesLabelMapFilter< TInputImage >::DataObjectPointerType

Definition at line 56 of file otbKMeansAttributesLabelMapFilter.h.

◆ DataObjectType

template<class TInputImage >
typedef itk::DataObject otb::KMeansAttributesLabelMapFilter< TInputImage >::DataObjectType

Definition at line 55 of file otbKMeansAttributesLabelMapFilter.h.

◆ DistanceType

template<class TInputImage >
typedef itk::Statistics::EuclideanDistanceMetric<VectorType> otb::KMeansAttributesLabelMapFilter< TInputImage >::DistanceType

Definition at line 75 of file otbKMeansAttributesLabelMapFilter.h.

◆ EstimatorType

template<class TInputImage >
typedef itk::Statistics::KdTreeBasedKmeansEstimator<TreeType> otb::KMeansAttributesLabelMapFilter< TInputImage >::EstimatorType

Definition at line 74 of file otbKMeansAttributesLabelMapFilter.h.

◆ InputImageConstPointer

template<class TInputImage >
typedef InputImageType::ConstPointer otb::KMeansAttributesLabelMapFilter< TInputImage >::InputImageConstPointer

Definition at line 51 of file otbKMeansAttributesLabelMapFilter.h.

◆ InputImagePixelType

template<class TInputImage >
typedef InputImageType::PixelType otb::KMeansAttributesLabelMapFilter< TInputImage >::InputImagePixelType

Definition at line 53 of file otbKMeansAttributesLabelMapFilter.h.

◆ InputImagePointer

template<class TInputImage >
typedef InputImageType::Pointer otb::KMeansAttributesLabelMapFilter< TInputImage >::InputImagePointer

Definition at line 50 of file otbKMeansAttributesLabelMapFilter.h.

◆ InputImageRegionType

template<class TInputImage >
typedef InputImageType::RegionType otb::KMeansAttributesLabelMapFilter< TInputImage >::InputImageRegionType

Definition at line 52 of file otbKMeansAttributesLabelMapFilter.h.

◆ InputImageType

template<class TInputImage >
typedef TInputImage otb::KMeansAttributesLabelMapFilter< TInputImage >::InputImageType

Some convenient typedefs.

Definition at line 49 of file otbKMeansAttributesLabelMapFilter.h.

◆ LabelMapToSampleListFilterType

Definition at line 68 of file otbKMeansAttributesLabelMapFilter.h.

◆ LabelObjectType

template<class TInputImage >
typedef InputImageType::LabelObjectType otb::KMeansAttributesLabelMapFilter< TInputImage >::LabelObjectType

Definition at line 54 of file otbKMeansAttributesLabelMapFilter.h.

◆ ListSampleType

template<class TInputImage >
typedef itk::Statistics::ListSample<VectorType> otb::KMeansAttributesLabelMapFilter< TInputImage >::ListSampleType

Definition at line 66 of file otbKMeansAttributesLabelMapFilter.h.

◆ MeasurementFunctorType

Definition at line 69 of file otbKMeansAttributesLabelMapFilter.h.

◆ Pointer

template<class TInputImage >
typedef itk::SmartPointer<Self> otb::KMeansAttributesLabelMapFilter< TInputImage >::Pointer

Definition at line 45 of file otbKMeansAttributesLabelMapFilter.h.

◆ Self

template<class TInputImage >
typedef KMeansAttributesLabelMapFilter otb::KMeansAttributesLabelMapFilter< TInputImage >::Self

Standard class typedefs.

Definition at line 43 of file otbKMeansAttributesLabelMapFilter.h.

◆ Superclass

template<class TInputImage >
typedef itk::LabelMapFilter<TInputImage, TInputImage> otb::KMeansAttributesLabelMapFilter< TInputImage >::Superclass

Definition at line 44 of file otbKMeansAttributesLabelMapFilter.h.

◆ TrainingListSampleType

template<class TInputImage >
typedef itk::Statistics::ListSample<ClassLabelVectorType> otb::KMeansAttributesLabelMapFilter< TInputImage >::TrainingListSampleType

Definition at line 67 of file otbKMeansAttributesLabelMapFilter.h.

◆ TreeGeneratorType

template<class TInputImage >
typedef itk::Statistics::WeightedCentroidKdTreeGenerator<ListSampleType> otb::KMeansAttributesLabelMapFilter< TInputImage >::TreeGeneratorType

Definition at line 72 of file otbKMeansAttributesLabelMapFilter.h.

◆ TreeType

template<class TInputImage >
typedef TreeGeneratorType::KdTreeType otb::KMeansAttributesLabelMapFilter< TInputImage >::TreeType

Definition at line 73 of file otbKMeansAttributesLabelMapFilter.h.

◆ VectorType

template<class TInputImage >
typedef itk::VariableLengthVector<AttributesValueType> otb::KMeansAttributesLabelMapFilter< TInputImage >::VectorType

Definition at line 63 of file otbKMeansAttributesLabelMapFilter.h.

Constructor & Destructor Documentation

◆ KMeansAttributesLabelMapFilter() [1/2]

template<class TInputImage >
otb::KMeansAttributesLabelMapFilter< TInputImage >::KMeansAttributesLabelMapFilter
protected

Return the centroids resulting from the KMeans

Definition at line 32 of file otbKMeansAttributesLabelMapFilter.hxx.

◆ ~KMeansAttributesLabelMapFilter()

template<class TInputImage >
otb::KMeansAttributesLabelMapFilter< TInputImage >::~KMeansAttributesLabelMapFilter ( )
inlineoverrideprotected

Return the centroids resulting from the KMeans

Definition at line 123 of file otbKMeansAttributesLabelMapFilter.h.

◆ KMeansAttributesLabelMapFilter() [2/2]

template<class TInputImage >
otb::KMeansAttributesLabelMapFilter< TInputImage >::KMeansAttributesLabelMapFilter ( const Self )
privatedelete

Return the centroids resulting from the KMeans

Member Function Documentation

◆ Compute()

template<class TInputImage >
void otb::KMeansAttributesLabelMapFilter< TInputImage >::Compute

Return the centroids resulting from the KMeans

Definition at line 38 of file otbKMeansAttributesLabelMapFilter.hxx.

◆ CreateAnother()

template<class TInputImage >
virtual::itk::LightObject::Pointer otb::KMeansAttributesLabelMapFilter< TInputImage >::CreateAnother ( void  ) const

◆ GetCentroids() [1/2]

template<class TInputImage >
CentroidsVectorType& otb::KMeansAttributesLabelMapFilter< TInputImage >::GetCentroids ( )
inline

Return the centroids resulting from the KMeans

Definition at line 88 of file otbKMeansAttributesLabelMapFilter.h.

◆ GetCentroids() [2/2]

template<class TInputImage >
const CentroidsVectorType& otb::KMeansAttributesLabelMapFilter< TInputImage >::GetCentroids ( ) const
inline

Return the centroids resulting from the KMeans

Definition at line 92 of file otbKMeansAttributesLabelMapFilter.h.

◆ GetMeasurementFunctor()

template<class TInputImage >
MeasurementFunctorType& otb::KMeansAttributesLabelMapFilter< TInputImage >::GetMeasurementFunctor ( )
inline

Return the centroids resulting from the KMeans

Definition at line 109 of file otbKMeansAttributesLabelMapFilter.h.

◆ GetNameOfClass()

template<class TInputImage >
virtual const char* otb::KMeansAttributesLabelMapFilter< TInputImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

◆ GetNumberOfClasses()

template<class TInputImage >
virtual unsigned int otb::KMeansAttributesLabelMapFilter< TInputImage >::GetNumberOfClasses ( )
virtual

Return the centroids resulting from the KMeans

◆ itkGetObjectMacro()

template<class TInputImage >
otb::KMeansAttributesLabelMapFilter< TInputImage >::itkGetObjectMacro ( InputLabelMap  ,
InputImageType   
)

Return the centroids resulting from the KMeans

◆ New()

template<class TInputImage >
static Pointer otb::KMeansAttributesLabelMapFilter< TInputImage >::New ( )
static

Standard New method.

◆ operator=()

template<class TInputImage >
void otb::KMeansAttributesLabelMapFilter< TInputImage >::operator= ( const Self )
privatedelete

Return the centroids resulting from the KMeans

◆ SetInputLabelMap()

template<class TInputImage >
virtual void otb::KMeansAttributesLabelMapFilter< TInputImage >::SetInputLabelMap ( InputImageType _arg)
virtual

Return the centroids resulting from the KMeans

◆ SetMeasurementFunctor()

template<class TInputImage >
void otb::KMeansAttributesLabelMapFilter< TInputImage >::SetMeasurementFunctor ( MeasurementFunctorType functor)
inline

Return the centroids resulting from the KMeans

Definition at line 114 of file otbKMeansAttributesLabelMapFilter.h.

◆ SetNumberOfClasses()

template<class TInputImage >
virtual void otb::KMeansAttributesLabelMapFilter< TInputImage >::SetNumberOfClasses ( unsigned int  _arg)
virtual

Set the number of classes of the input sample list. It will be used to choose the number of centroids. In the one-class case, 10 centroids is chosen. Otherwise, a number of centroids equal to the number of classes

Member Data Documentation

◆ InputImageDimension

template<class TInputImage >
const unsigned int otb::KMeansAttributesLabelMapFilter< TInputImage >::InputImageDimension = TInputImage::ImageDimension
static

ImageDimension constants

Definition at line 79 of file otbKMeansAttributesLabelMapFilter.h.

◆ m_Centroids

template<class TInputImage >
CentroidsVectorType otb::KMeansAttributesLabelMapFilter< TInputImage >::m_Centroids
private

Return the centroids resulting from the KMeans

Definition at line 131 of file otbKMeansAttributesLabelMapFilter.h.

◆ m_InputLabelMap

template<class TInputImage >
InputImagePointer otb::KMeansAttributesLabelMapFilter< TInputImage >::m_InputLabelMap
private

Return the centroids resulting from the KMeans

Definition at line 130 of file otbKMeansAttributesLabelMapFilter.h.

◆ m_LabelMapToSampleListFilter

template<class TInputImage >
LabelMapToSampleListFilterType::Pointer otb::KMeansAttributesLabelMapFilter< TInputImage >::m_LabelMapToSampleListFilter
private

Return the centroids resulting from the KMeans

Definition at line 133 of file otbKMeansAttributesLabelMapFilter.h.

◆ m_NumberOfClasses

template<class TInputImage >
unsigned int otb::KMeansAttributesLabelMapFilter< TInputImage >::m_NumberOfClasses
private

Return the centroids resulting from the KMeans

Definition at line 134 of file otbKMeansAttributesLabelMapFilter.h.


The documentation for this class was generated from the following files: