OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage > Class Template Reference
Processing images region by region » Filters supporting StreamingGroup Learning » | Module OTBSOM

#include <otbSOMImageClassificationFilter.h>

+ Inheritance diagram for otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >:
+ Collaboration diagram for otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >:

Public Types

typedef ClassifierType::Pointer ClassifierPointerType
 
typedef otb::SOMClassifier< ListSampleType, SOMMapType, LabelType > ClassifierType
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef InputImageType::ConstPointer InputImageConstPointerType
 
typedef TInputImage InputImageType
 
typedef OutputImageType::PixelType LabelType
 
typedef ListSampleType::Pointer ListSamplePointerType
 
typedef itk::Statistics::ListSample< SampleType > ListSampleType
 
typedef MaskImageType::ConstPointer MaskImageConstPointerType
 
typedef MaskImageType::Pointer MaskImagePointerType
 
typedef TMaskImage MaskImageType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef SOMMapType::PixelType SampleType
 
typedef SOMImageClassificationFilter Self
 
typedef SOMMapType::Pointer SOMMapPointerType
 
typedef TSOMMap SOMMapType
 
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage > Superclass
 
typedef InputImageType::InternalPixelType ValueType
 

Public Member Functions

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

Static Public Member Functions

static Pointer New ()
 
SOMMapPointerType m_Map
 
LabelType m_DefaultLabel
 
virtual void SetMap (SOMMapType *_arg)
 
 itkGetObjectMacro (Map, SOMMapType)
 
virtual void SetDefaultLabel (LabelType _arg)
 
virtual LabelType GetDefaultLabel ()
 
void SetInputMask (const MaskImageType *mask)
 
const MaskImageType * GetInputMask (void)
 
 SOMImageClassificationFilter ()
 
 ~SOMImageClassificationFilter () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void BeforeThreadedGenerateData () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 SOMImageClassificationFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage, class TOutputImage, class TSOMMap, class TMaskImage = TOutputImage>
class otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >

This filter performs the classification of a VectorImage using a given SOM map.

This filter is streamed and threaded, allowing to classify huge images. Because the internal sample type has to be an itk::FixedArray, one must specify at compilation time the maximum sample dimension. It is up to the user to specify a MaxSampleDimension sufficiently high to integrate all its features. This filter internally use one SVMClassifier per thread.

See also
SVMClassifier

Definition at line 45 of file otbSOMImageClassificationFilter.h.

Member Typedef Documentation

◆ ClassifierPointerType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef ClassifierType::Pointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::ClassifierPointerType

Definition at line 80 of file otbSOMImageClassificationFilter.h.

◆ ClassifierType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef otb::SOMClassifier<ListSampleType, SOMMapType, LabelType> otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::ClassifierType

Definition at line 79 of file otbSOMImageClassificationFilter.h.

◆ ConstPointer

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef itk::SmartPointer<const Self> otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::ConstPointer

Definition at line 52 of file otbSOMImageClassificationFilter.h.

◆ InputImageConstPointerType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef InputImageType::ConstPointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::InputImageConstPointerType

Definition at line 61 of file otbSOMImageClassificationFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef TInputImage otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::InputImageType

Definition at line 58 of file otbSOMImageClassificationFilter.h.

◆ LabelType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef OutputImageType::PixelType otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::LabelType

Definition at line 71 of file otbSOMImageClassificationFilter.h.

◆ ListSamplePointerType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef ListSampleType::Pointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::ListSamplePointerType

Definition at line 78 of file otbSOMImageClassificationFilter.h.

◆ ListSampleType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef itk::Statistics::ListSample<SampleType> otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::ListSampleType

Definition at line 77 of file otbSOMImageClassificationFilter.h.

◆ MaskImageConstPointerType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef MaskImageType::ConstPointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::MaskImageConstPointerType

Definition at line 65 of file otbSOMImageClassificationFilter.h.

◆ MaskImagePointerType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef MaskImageType::Pointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::MaskImagePointerType

Definition at line 66 of file otbSOMImageClassificationFilter.h.

◆ MaskImageType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef TMaskImage otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::MaskImageType

Definition at line 64 of file otbSOMImageClassificationFilter.h.

◆ OutputImagePointerType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef OutputImageType::Pointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::OutputImagePointerType

Definition at line 69 of file otbSOMImageClassificationFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef OutputImageType::RegionType otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::OutputImageRegionType

Definition at line 70 of file otbSOMImageClassificationFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef TOutputImage otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::OutputImageType

Definition at line 68 of file otbSOMImageClassificationFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef itk::SmartPointer<Self> otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::Pointer

Definition at line 51 of file otbSOMImageClassificationFilter.h.

◆ SampleType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef SOMMapType::PixelType otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::SampleType

Definition at line 75 of file otbSOMImageClassificationFilter.h.

◆ Self

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef SOMImageClassificationFilter otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::Self

Standard typedefs

Definition at line 49 of file otbSOMImageClassificationFilter.h.

◆ SOMMapPointerType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef SOMMapType::Pointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::SOMMapPointerType

Definition at line 74 of file otbSOMImageClassificationFilter.h.

◆ SOMMapType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef TSOMMap otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::SOMMapType

Definition at line 73 of file otbSOMImageClassificationFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef itk::InPlaceImageFilter<TInputImage, TOutputImage> otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::Superclass

Definition at line 50 of file otbSOMImageClassificationFilter.h.

◆ ValueType

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
typedef InputImageType::InternalPixelType otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::ValueType

Definition at line 62 of file otbSOMImageClassificationFilter.h.

Constructor & Destructor Documentation

◆ SOMImageClassificationFilter() [1/2]

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::SOMImageClassificationFilter ( )
protected

Constructor

◆ ~SOMImageClassificationFilter()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::~SOMImageClassificationFilter ( )
inlineoverrideprotected

Destructor

Definition at line 109 of file otbSOMImageClassificationFilter.h.

◆ SOMImageClassificationFilter() [2/2]

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::SOMImageClassificationFilter ( const Self &  )
privatedelete

The SOM model used for classification

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
void otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::BeforeThreadedGenerateData ( )
overrideprotected

Before threaded generate data

◆ CreateAnother()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
virtual::itk::LightObject::Pointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::CreateAnother ( void  ) const

◆ GetDefaultLabel()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
virtual LabelType otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::GetDefaultLabel ( )
virtual

The SOM model used for classification

◆ GetInputMask()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
const MaskImageType* otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::GetInputMask ( void  )

Get the input mask.

Returns
The mask.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
virtual const char* otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::GetNameOfClass ( ) const
virtual

Creation through object factory macro

◆ itkGetObjectMacro()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::itkGetObjectMacro ( Map  ,
SOMMapType   
)

The SOM model used for classification

◆ New()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
static Pointer otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::New ( )
static

Type macro

◆ operator=()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
void otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::operator= ( const Self &  )
privatedelete

The SOM model used for classification

◆ PrintSelf()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
void otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

PrintSelf method

◆ SetDefaultLabel()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
virtual void otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::SetDefaultLabel ( LabelType  _arg)
virtual

Set/Get the default label

◆ SetInputMask()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
void otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::SetInputMask ( const MaskImageType *  mask)

If set, only pixels within the mask will be classified.

Parameters
maskThe input mask.

◆ SetMap()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
virtual void otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::SetMap ( SOMMapType *  _arg)
virtual

Set/Get the svm model

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
void otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

Threaded generate data

Member Data Documentation

◆ m_DefaultLabel

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
LabelType otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::m_DefaultLabel
private

Default label for invalid pixels (when using a mask)

Definition at line 130 of file otbSOMImageClassificationFilter.h.

◆ m_Map

template<class TInputImage , class TOutputImage , class TSOMMap , class TMaskImage = TOutputImage>
SOMMapPointerType otb::SOMImageClassificationFilter< TInputImage, TOutputImage, TSOMMap, TMaskImage >::m_Map
private

The SOM model used for classification

Definition at line 127 of file otbSOMImageClassificationFilter.h.

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