OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap > Class Template Reference
Processing images region by region » Filters supporting StreamingGroup Learning » | Module OTBSOM

#include <otbSOMbasedImageFilter.h>

+ Inheritance diagram for otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >:
+ Collaboration diagram for otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef DistanceMetricType::Pointer DistanceMetricPointerType
 
typedef TDistanceMetric DistanceMetricType
 
typedef Functor::SOMbasedImageFilterFunctor< typename TInputImage::PixelType, typename TOutputImage::PixelType, TDistanceMetric, TMap > FunctorType
 
typedef MapType::Pointer MapPointerType
 
typedef TMap MapType
 
typedef TInputImage::PixelType MeasurementType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef SOMbasedImageFilter Self
 
typedef itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::SOMbasedImageFilterFunctor< typename TInputImage::PixelType, typename TOutputImage::PixelType, TDistanceMetric, TMap > > Superclass
 

Public Member Functions

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

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void BeforeThreadedGenerateData (void) override
 
 SOMbasedImageFilter ()
 
 ~SOMbasedImageFilter () override
 

Private Member Functions

void operator= (const Self &)=delete
 
 SOMbasedImageFilter (const Self &)
 

Private Attributes

MapPointerType m_Map
 

Detailed Description

template<class TInputImage, class TOutputImage, class TDistanceMetric, class TMap>
class otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >

This class perform the substitution between initial input image pixels and the winning neurons of a SOM.

It performs the projection of the SOM onto the data. On the contrary to otb::SOMClassifier, it does not yield labels but an image which corresponds to the quantized version of the initial image when considering SOMmap as a codebook of a vector quantization.

SOMbasedImageFilter is templated over a TDistanceMetric since it could be different from the initial DistanceMetric used for the SOM training. Moreover TMap is a template for the SOM that can be a simple VectorImage.

See also
EuclideanDistanceMetricWithMissingValue

Definition at line 117 of file otbSOMbasedImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef itk::SmartPointer<const Self> otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::ConstPointer

Definition at line 129 of file otbSOMbasedImageFilter.h.

◆ DistanceMetricPointerType

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef DistanceMetricType::Pointer otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::DistanceMetricPointerType

Definition at line 139 of file otbSOMbasedImageFilter.h.

◆ DistanceMetricType

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef TDistanceMetric otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::DistanceMetricType

Some convenient typedefs.

Definition at line 135 of file otbSOMbasedImageFilter.h.

◆ FunctorType

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef Functor::SOMbasedImageFilterFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType, TDistanceMetric, TMap> otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::FunctorType

Definition at line 144 of file otbSOMbasedImageFilter.h.

◆ MapPointerType

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef MapType::Pointer otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::MapPointerType

Definition at line 142 of file otbSOMbasedImageFilter.h.

◆ MapType

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef TMap otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::MapType

Definition at line 141 of file otbSOMbasedImageFilter.h.

◆ MeasurementType

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef TInputImage::PixelType otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::MeasurementType

Vectors that hold the training area

Definition at line 147 of file otbSOMbasedImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef itk::SmartPointer<Self> otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::Pointer

Definition at line 128 of file otbSOMbasedImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef SOMbasedImageFilter otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::Self

Standard class typedefs.

Definition at line 124 of file otbSOMbasedImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
typedef itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::SOMbasedImageFilterFunctor<typename TInputImage::PixelType, typename TOutputImage::PixelType, TDistanceMetric, TMap> > otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::Superclass

Definition at line 127 of file otbSOMbasedImageFilter.h.

Constructor & Destructor Documentation

◆ SOMbasedImageFilter() [1/2]

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::SOMbasedImageFilter
protected

Definition at line 81 of file otbSOMbasedImageFilter.hxx.

◆ ~SOMbasedImageFilter()

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::~SOMbasedImageFilter ( )
inlineoverrideprotected

Definition at line 157 of file otbSOMbasedImageFilter.h.

◆ SOMbasedImageFilter() [2/2]

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::SOMbasedImageFilter ( const Self &  )
private

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
void otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::BeforeThreadedGenerateData ( void  )
overrideprotected

Definition at line 95 of file otbSOMbasedImageFilter.hxx.

◆ CreateAnother()

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
virtual::itk::LightObject::Pointer otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::CreateAnother ( void  ) const

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
virtual const char* otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ New()

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
static Pointer otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
void otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::operator= ( const Self &  )
privatedelete

◆ SetMap()

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
void otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::SetMap ( const MapType *  theMap)

Set the SOM map (or VectorImage)

Definition at line 88 of file otbSOMbasedImageFilter.hxx.

Member Data Documentation

◆ m_Map

template<class TInputImage , class TOutputImage , class TDistanceMetric , class TMap >
MapPointerType otb::SOMbasedImageFilter< TInputImage, TOutputImage, TDistanceMetric, TMap >::m_Map
private

Definition at line 165 of file otbSOMbasedImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:27 for OTB with   doxygen 1.8.17