otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage > Class Template Reference

#include <otbImageDimensionalityReductionFilter.h>

Inheritance diagram for otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >:

Collaboration diagram for otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >:

Public Types
typedef ConfidenceImageType::Pointer	ConfidenceImagePointerType
typedef otb::Image< double >	ConfidenceImageType
typedef itk::SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointerType
typedef TInputImage	InputImageType
typedef OutputImageType::InternalPixelType	LabelType
typedef MaskImageType::ConstPointer	MaskImageConstPointerType
typedef MaskImageType::Pointer	MaskImagePointerType
typedef TMaskImage	MaskImageType
typedef ModelType::Pointer	ModelPointerType
typedef MachineLearningModel< itk::VariableLengthVector< ValueType >, itk::VariableLengthVector< LabelType > >	ModelType
typedef OutputImageType::Pointer	OutputImagePointerType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef ImageDimensionalityReductionFilter	Self
typedef itk::ImageToImageFilter< 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 ()
ModelPointerType	m_Model
LabelType	m_DefaultLabel
bool	m_UseConfidenceMap
bool	m_BatchMode
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	SetBatchMode (bool _arg)
virtual bool	GetBatchMode ()
virtual void	BatchModeOn ()
virtual void	BatchModeOff ()
void	SetInputMask (const MaskImageType *mask)
const MaskImageType *	GetInputMask (void)
ConfidenceImageType *	GetOutputConfidence (void)
	ImageDimensionalityReductionFilter ()
	~ImageDimensionalityReductionFilter () override
virtual void	GenerateOutputInformation () override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
void	ClassicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
void	BatchThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
void	BeforeThreadedGenerateData () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	ImageDimensionalityReductionFilter (const Self &)=delete
void	operator= (const Self &)=delete

Detailed Description

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

Definition at line 42 of file otbImageDimensionalityReductionFilter.h.

Member Typedef Documentation

ConfidenceImagePointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef ConfidenceImageType::Pointer otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ConfidenceImagePointerType

Definition at line 74 of file otbImageDimensionalityReductionFilter.h.

ConfidenceImageType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef otb::Image<double> otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ConfidenceImageType

Definition at line 73 of file otbImageDimensionalityReductionFilter.h.

ConstPointer

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef itk::SmartPointer<const Self> otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ConstPointer

Definition at line 49 of file otbImageDimensionalityReductionFilter.h.

InputImageConstPointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef InputImageType::ConstPointer otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::InputImageConstPointerType

Definition at line 58 of file otbImageDimensionalityReductionFilter.h.

InputImageType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef TInputImage otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::InputImageType

Definition at line 55 of file otbImageDimensionalityReductionFilter.h.

LabelType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef OutputImageType::InternalPixelType otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::LabelType

Definition at line 68 of file otbImageDimensionalityReductionFilter.h.

MaskImageConstPointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef MaskImageType::ConstPointer otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageConstPointerType

Definition at line 62 of file otbImageDimensionalityReductionFilter.h.

MaskImagePointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef MaskImageType::Pointer otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::MaskImagePointerType

Definition at line 63 of file otbImageDimensionalityReductionFilter.h.

MaskImageType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef TMaskImage otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageType

Definition at line 61 of file otbImageDimensionalityReductionFilter.h.

ModelPointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef ModelType::Pointer otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ModelPointerType

Definition at line 71 of file otbImageDimensionalityReductionFilter.h.

ModelType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef MachineLearningModel<itk::VariableLengthVector<ValueType>, itk::VariableLengthVector<LabelType> > otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ModelType

Definition at line 70 of file otbImageDimensionalityReductionFilter.h.

OutputImagePointerType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef OutputImageType::Pointer otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::OutputImagePointerType

Definition at line 66 of file otbImageDimensionalityReductionFilter.h.

OutputImageRegionType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef OutputImageType::RegionType otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageRegionType

Definition at line 67 of file otbImageDimensionalityReductionFilter.h.

OutputImageType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef TOutputImage otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageType

Definition at line 65 of file otbImageDimensionalityReductionFilter.h.

Pointer

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef itk::SmartPointer<Self> otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::Pointer

Definition at line 48 of file otbImageDimensionalityReductionFilter.h.

Self

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef ImageDimensionalityReductionFilter otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::Self

Standard typedefs

Definition at line 46 of file otbImageDimensionalityReductionFilter.h.

Superclass

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::Superclass

Definition at line 47 of file otbImageDimensionalityReductionFilter.h.

ValueType

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

typedef InputImageType::InternalPixelType otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ValueType

Definition at line 59 of file otbImageDimensionalityReductionFilter.h.

Constructor & Destructor Documentation

ImageDimensionalityReductionFilter() [1/2]

template<class TInputImage , class TOutputImage , class TMaskImage >

otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ImageDimensionalityReductionFilter

protected

Constructor

Definition at line 33 of file otbImageDimensionalityReductionFilter.hxx.

~ImageDimensionalityReductionFilter()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::~ImageDimensionalityReductionFilter ( )

inlineoverrideprotected

Destructor

Definition at line 118 of file otbImageDimensionalityReductionFilter.h.

ImageDimensionalityReductionFilter() [2/2]

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ImageDimensionalityReductionFilter ( const Self &  )

privatedelete

The model used for classification

Member Function Documentation

BatchModeOff()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::BatchModeOff ( )

virtual

The model used for classification

BatchModeOn()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::BatchModeOn ( )

virtual

The model used for classification

BatchThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TMaskImage >

void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::BatchThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, itk::ThreadIdType  threadId  )

protected

The model used for classification

Definition at line 127 of file otbImageDimensionalityReductionFilter.hxx.

BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TMaskImage >

void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::BeforeThreadedGenerateData

overrideprotected

Before threaded generate data

Definition at line 75 of file otbImageDimensionalityReductionFilter.hxx.

ClassicThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TMaskImage >

void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ClassicThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, itk::ThreadIdType  threadId  )

protected

The model used for classification

Definition at line 87 of file otbImageDimensionalityReductionFilter.hxx.

CreateAnother()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual::itk::LightObject::Pointer otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::CreateAnother

(

void

)

const

GenerateOutputInformation()

template<class TInputImage , class TOutputImage , class TMaskImage >

void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::GenerateOutputInformation

overrideprotectedvirtual

Generate output information

Definition at line 116 of file otbImageDimensionalityReductionFilter.hxx.

GetBatchMode()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual bool otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::GetBatchMode ( )

virtual

The model used for classification

GetDefaultLabel()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual LabelType otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::GetDefaultLabel ( )

virtual

The model used for classification

GetInputMask()

template<class TInputImage , class TOutputImage , class TMaskImage >

const ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageType * otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::GetInputMask

(

void

)

Get the input mask.

Returns

The mask.

Definition at line 54 of file otbImageDimensionalityReductionFilter.hxx.

GetNameOfClass()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual const char* otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::GetNameOfClass ( ) const

virtual

Creation through object factory macro

GetOutputConfidence()

template<class TInputImage , class TOutputImage , class TMaskImage >

ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ConfidenceImageType * otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::GetOutputConfidence

(

void

)

Get the output confidence map

Definition at line 65 of file otbImageDimensionalityReductionFilter.hxx.

GetUseConfidenceMap()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual bool otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::GetUseConfidenceMap ( )

virtual

The model used for classification

itkGetObjectMacro()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::itkGetObjectMacro	(	Model	,
		ModelType
	)

The model used for classification

New()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

static Pointer otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::New ( )

static

Type macro

operator=()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::operator= ( const Self &  )

privatedelete

The model used for classification

PrintSelf()

template<class TInputImage , class TOutputImage , class TMaskImage >

void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

PrintSelf method

PrintSelf Method

Definition at line 202 of file otbImageDimensionalityReductionFilter.hxx.

SetBatchMode()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::SetBatchMode ( bool  _arg )

virtual

The model used for classification

SetDefaultLabel()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::SetDefaultLabel ( LabelType  _arg )

virtual

Set/Get the default label

SetInputMask()

template<class TInputImage , class TOutputImage , class TMaskImage >

void otb::ImageDimensionalityReductionFilter< 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

mask	The input mask.

Definition at line 47 of file otbImageDimensionalityReductionFilter.hxx.

SetModel()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::SetModel ( ModelType *  _arg )

virtual

Set/Get the model

SetUseConfidenceMap()

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

virtual void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::SetUseConfidenceMap ( bool  _arg )

virtual

Set/Get the confidence map flag

ThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TMaskImage >

void otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, itk::ThreadIdType  threadId  )

overrideprotected

Threaded generate data

Definition at line 185 of file otbImageDimensionalityReductionFilter.hxx.

Member Data Documentation

m_BatchMode

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

bool otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::m_BatchMode

private

The model used for classification

Definition at line 148 of file otbImageDimensionalityReductionFilter.h.

m_DefaultLabel

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

LabelType otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::m_DefaultLabel

private

Default label for invalid pixels (when using a mask)

Definition at line 144 of file otbImageDimensionalityReductionFilter.h.

m_Model

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

ModelPointerType otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::m_Model

private

The model used for classification

Definition at line 141 of file otbImageDimensionalityReductionFilter.h.

m_UseConfidenceMap

template<class TInputImage , class TOutputImage , class TMaskImage = TOutputImage>

bool otb::ImageDimensionalityReductionFilter< TInputImage, TOutputImage, TMaskImage >::m_UseConfidenceMap

private

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

Definition at line 147 of file otbImageDimensionalityReductionFilter.h.

---

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

• otbImageDimensionalityReductionFilter.h
• otbImageDimensionalityReductionFilter.hxx