OTB  7.2.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::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage > Class Template Reference

#include <otbImageClassificationFilter.h>

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

Public Types

typedef ConfidenceImageType::Pointer ConfidenceImagePointerType
 
typedef otb::Image< double > ConfidenceImageType
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputImageType::ConstPointer InputImageConstPointerType
 
typedef TInputImage InputImageType
 
typedef OutputImageType::PixelType LabelType
 
typedef MaskImageType::ConstPointer MaskImageConstPointerType
 
typedef MaskImageType::Pointer MaskImagePointerType
 
typedef TMaskImage MaskImageType
 
typedef ModelType::Pointer ModelPointerType
 
typedef MachineLearningModel< ValueType, LabelTypeModelType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ProbaImageType::Pointer ProbaImagePointerType
 
typedef otb::VectorImage< double > ProbaImageType
 
typedef itk::VariableLengthVector< double > ProbaSampleType
 
typedef ImageClassificationFilter Self
 
typedef itk::ImageToImageFilter< TInputImage, TOutputImage > Superclass
 
typedef InputImageType::InternalPixelType ValueType
 

Public Member Functions

virtual void BatchModeOff ()
 
virtual void BatchModeOn ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual bool GetBatchMode ()
 
const MaskImageTypeGetInputMask (void)
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfClasses ()
 
virtual void SetBatchMode (bool _arg)
 
void SetInputMask (const MaskImageType *mask)
 
virtual void SetNumberOfClasses (unsigned int _arg)
 
virtual void SetModel (ModelType *_arg)
 
 itkGetObjectMacro (Model, ModelType)
 
virtual void SetDefaultLabel (LabelType _arg)
 
virtual LabelType GetDefaultLabel ()
 
virtual void SetUseConfidenceMap (bool _arg)
 
virtual bool GetUseConfidenceMap ()
 
virtual void SetUseProbaMap (bool _arg)
 
virtual bool GetUseProbaMap ()
 
ConfidenceImageTypeGetOutputConfidence (void)
 
ProbaImageTypeGetOutputProba (void)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void BatchThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 
void BeforeThreadedGenerateData () override
 
void ClassicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 
void GenerateOutputInformation () override
 
 ImageClassificationFilter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 ~ImageClassificationFilter () override
 

Private Member Functions

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

Private Attributes

bool m_BatchMode
 
LabelType m_DefaultLabel
 
ModelPointerType m_Model
 
unsigned int m_NumberOfClasses
 
bool m_UseConfidenceMap
 
bool m_UseProbaMap
 

Detailed Description

template<class TInputImage, class TOutputImage, class TMaskImage = TOutputImage>
class otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >

This filter performs the classification of a VectorImage using a Model.

This filter is streamed and threaded, allowing to classify huge images while fully using several core.

See also
Classifier

Definition at line 44 of file otbImageClassificationFilter.h.

Member Typedef Documentation

◆ ConfidenceImagePointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
typedef ConfidenceImageType::Pointer otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::ConfidenceImagePointerType

Definition at line 76 of file otbImageClassificationFilter.h.

◆ ConfidenceImageType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
typedef otb::Image<double> otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::ConfidenceImageType

Definition at line 75 of file otbImageClassificationFilter.h.

◆ ConstPointer

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

Definition at line 51 of file otbImageClassificationFilter.h.

◆ InputImageConstPointerType

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

Definition at line 60 of file otbImageClassificationFilter.h.

◆ InputImageType

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

Definition at line 57 of file otbImageClassificationFilter.h.

◆ LabelType

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

Definition at line 70 of file otbImageClassificationFilter.h.

◆ MaskImageConstPointerType

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

Definition at line 64 of file otbImageClassificationFilter.h.

◆ MaskImagePointerType

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

Definition at line 65 of file otbImageClassificationFilter.h.

◆ MaskImageType

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

Definition at line 63 of file otbImageClassificationFilter.h.

◆ ModelPointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
typedef ModelType::Pointer otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::ModelPointerType

Definition at line 73 of file otbImageClassificationFilter.h.

◆ ModelType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
typedef MachineLearningModel<ValueType, LabelType> otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::ModelType

Definition at line 72 of file otbImageClassificationFilter.h.

◆ OutputImagePointerType

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

Definition at line 68 of file otbImageClassificationFilter.h.

◆ OutputImageRegionType

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

Definition at line 69 of file otbImageClassificationFilter.h.

◆ OutputImageType

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

Definition at line 67 of file otbImageClassificationFilter.h.

◆ Pointer

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

Definition at line 50 of file otbImageClassificationFilter.h.

◆ ProbaImagePointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
typedef ProbaImageType::Pointer otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::ProbaImagePointerType

Definition at line 81 of file otbImageClassificationFilter.h.

◆ ProbaImageType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
typedef otb::VectorImage<double> otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::ProbaImageType

Output type for Proba

Definition at line 79 of file otbImageClassificationFilter.h.

◆ ProbaSampleType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
typedef itk::VariableLengthVector<double> otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::ProbaSampleType

Definition at line 82 of file otbImageClassificationFilter.h.

◆ Self

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

Standard typedefs

Definition at line 48 of file otbImageClassificationFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::Superclass

Definition at line 49 of file otbImageClassificationFilter.h.

◆ ValueType

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

Definition at line 61 of file otbImageClassificationFilter.h.

Constructor & Destructor Documentation

◆ ImageClassificationFilter() [1/2]

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

Constructor

◆ ~ImageClassificationFilter()

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

Destructor

Definition at line 134 of file otbImageClassificationFilter.h.

◆ ImageClassificationFilter() [2/2]

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

Member Function Documentation

◆ BatchModeOff()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::BatchModeOff ( )
virtual

◆ BatchModeOn()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::BatchModeOn ( )
virtual

◆ BatchThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::BatchThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protected

◆ BeforeThreadedGenerateData()

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

Before threaded generate data

◆ ClassicThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::ClassicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
itk::ThreadIdType  threadId 
)
protected

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::GenerateOutputInformation ( void  )
inlineoverrideprotected

Definition at line 149 of file otbImageClassificationFilter.h.

◆ GetBatchMode()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual bool otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::GetBatchMode ( )
virtual

◆ GetDefaultLabel()

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

Set/Get the default label

◆ GetInputMask()

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

Get the input mask.

Returns
The mask.

◆ GetNameOfClass()

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

Creation through object factory macro

◆ GetNumberOfClasses()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual unsigned int otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::GetNumberOfClasses ( )
virtual

◆ GetOutputConfidence()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
ConfidenceImageType* otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::GetOutputConfidence ( void  )

Get the output confidence map

◆ GetOutputProba()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
ProbaImageType* otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::GetOutputProba ( void  )

Get the output confidence map

◆ GetUseConfidenceMap()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual bool otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::GetUseConfidenceMap ( )
virtual

Set/Get the confidence map flag

◆ GetUseProbaMap()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual bool otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::GetUseProbaMap ( )
virtual

Set/Get the proba map flag

◆ itkGetObjectMacro()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::itkGetObjectMacro ( Model  ,
ModelType   
)

Set/Get the model

◆ New()

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

Type macro

◆ operator=()

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

◆ PrintSelf()

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

PrintSelf method

◆ SetBatchMode()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::SetBatchMode ( bool  _arg)
virtual

◆ SetDefaultLabel()

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

Set/Get the default label

◆ SetInputMask()

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

If set, only pixels within the mask will be classified. All pixels with a value greater than 0 in the mask, will be classified.

Parameters
maskThe input mask.

◆ SetModel()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::SetModel ( ModelType _arg)
virtual

Set/Get the model

◆ SetNumberOfClasses()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::SetNumberOfClasses ( unsigned int  _arg)
virtual

◆ SetUseConfidenceMap()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::SetUseConfidenceMap ( bool  _arg)
virtual

Set/Get the confidence map flag

◆ SetUseProbaMap()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
virtual void otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::SetUseProbaMap ( bool  _arg)
virtual

Set/Get the proba map flag

◆ ThreadedGenerateData()

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

Threaded generate data

Member Data Documentation

◆ m_BatchMode

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
bool otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::m_BatchMode
private

Definition at line 169 of file otbImageClassificationFilter.h.

◆ m_DefaultLabel

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

Default label for invalid pixels (when using a mask)

Definition at line 164 of file otbImageClassificationFilter.h.

◆ m_Model

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
ModelPointerType otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::m_Model
private

The model used for classification

Definition at line 161 of file otbImageClassificationFilter.h.

◆ m_NumberOfClasses

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
unsigned int otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::m_NumberOfClasses
private

Definition at line 170 of file otbImageClassificationFilter.h.

◆ m_UseConfidenceMap

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
bool otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::m_UseConfidenceMap
private

Flag to produce the confidence map (if the model supports it)

Definition at line 167 of file otbImageClassificationFilter.h.

◆ m_UseProbaMap

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>
bool otb::ImageClassificationFilter< TInputImage, TOutputImage, TMaskImage >::m_UseProbaMap
private

Definition at line 168 of file otbImageClassificationFilter.h.


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