otb::PersistentFilterStreamingDecorator< TFilter > Class Template Reference

#include <otbPersistentFilterStreamingDecorator.h>

Inheritance diagram for otb::PersistentFilterStreamingDecorator< TFilter >:

Collaboration diagram for otb::PersistentFilterStreamingDecorator< TFilter >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef FilterType::Pointer	FilterPointerType
typedef TFilter	FilterType
typedef FilterType::InputImageType	ImageType
typedef itk::SmartPointer< Self >	Pointer
typedef PersistentFilterStreamingDecorator	Self
typedef StreamerType::Pointer	StreamerPointerType
typedef StreamingImageVirtualWriter< ImageType >	StreamerType
typedef itk::ProcessObject	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const FilterType *	GetFilter () const
virtual const char *	GetNameOfClass () const
	itkGetObjectMacro (Filter, FilterType)
	itkGetObjectMacro (Streamer, StreamerType)
virtual void	SetFilter (FilterType *_arg)
void	Update (void) override

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	GenerateData (void) override
	PersistentFilterStreamingDecorator ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	~PersistentFilterStreamingDecorator () override

Protected Attributes
FilterPointerType	m_Filter
StreamerPointerType	m_Streamer

Private Member Functions
void	operator= (const Self &)=delete
	PersistentFilterStreamingDecorator (const Self &)=delete

Detailed Description

template<class TFilter>
class otb::PersistentFilterStreamingDecorator< TFilter >

This filter link a persistent filter with a StreamingImageVirtualWriter.

The StreamingVirtualWriter will break the input image into pieces and stream each piece through the persistent filter. That way, the persistent filter will computes its data on the whole image, but never loads the whole of it, and eventually processes each piece with multiple threads. Before the streaming of the whole image is triggered, the Reset() method of the persistent filter is called to clear the temporary data it might contain. After the streaming, the Synthetize() method is called to synthetize the temporary data. One can access the persistent filter via the GetFilter() method, and StreamingVirtualWriter via the GetStreamer() method.

See also

StreamingStatisticsImageFilter

StreamingStatisticsVectorImageFilter

Definition at line 47 of file otbPersistentFilterStreamingDecorator.h.

Member Typedef Documentation

ConstPointer

template<class TFilter >

typedef itk::SmartPointer<const Self> otb::PersistentFilterStreamingDecorator< TFilter >::ConstPointer

Definition at line 54 of file otbPersistentFilterStreamingDecorator.h.

FilterPointerType

template<class TFilter >

typedef FilterType::Pointer otb::PersistentFilterStreamingDecorator< TFilter >::FilterPointerType

Definition at line 64 of file otbPersistentFilterStreamingDecorator.h.

FilterType

template<class TFilter >

typedef TFilter otb::PersistentFilterStreamingDecorator< TFilter >::FilterType

Template parameters typedefs

Definition at line 60 of file otbPersistentFilterStreamingDecorator.h.

ImageType

template<class TFilter >

typedef FilterType::InputImageType otb::PersistentFilterStreamingDecorator< TFilter >::ImageType

Definition at line 65 of file otbPersistentFilterStreamingDecorator.h.

Pointer

template<class TFilter >

typedef itk::SmartPointer<Self> otb::PersistentFilterStreamingDecorator< TFilter >::Pointer

Definition at line 53 of file otbPersistentFilterStreamingDecorator.h.

Self

template<class TFilter >

typedef PersistentFilterStreamingDecorator otb::PersistentFilterStreamingDecorator< TFilter >::Self

Standard typedefs

Definition at line 51 of file otbPersistentFilterStreamingDecorator.h.

StreamerPointerType

template<class TFilter >

typedef StreamerType::Pointer otb::PersistentFilterStreamingDecorator< TFilter >::StreamerPointerType

Definition at line 68 of file otbPersistentFilterStreamingDecorator.h.

StreamerType

template<class TFilter >

typedef StreamingImageVirtualWriter<ImageType> otb::PersistentFilterStreamingDecorator< TFilter >::StreamerType

Definition at line 67 of file otbPersistentFilterStreamingDecorator.h.

Superclass

template<class TFilter >

typedef itk::ProcessObject otb::PersistentFilterStreamingDecorator< TFilter >::Superclass

Definition at line 52 of file otbPersistentFilterStreamingDecorator.h.

Constructor & Destructor Documentation

PersistentFilterStreamingDecorator() [1/2]

template<class TFilter >

otb::PersistentFilterStreamingDecorator< TFilter >::PersistentFilterStreamingDecorator ( )

protected

Constructor

~PersistentFilterStreamingDecorator()

template<class TFilter >

otb::PersistentFilterStreamingDecorator< TFilter >::~PersistentFilterStreamingDecorator ( )

inlineoverrideprotected

Destructor

Definition at line 82 of file otbPersistentFilterStreamingDecorator.h.

PersistentFilterStreamingDecorator() [2/2]

template<class TFilter >

otb::PersistentFilterStreamingDecorator< TFilter >::PersistentFilterStreamingDecorator ( const Self &  )

privatedelete

Member Function Documentation

CreateAnother()

template<class TFilter >

virtual::itk::LightObject::Pointer otb::PersistentFilterStreamingDecorator< TFilter >::CreateAnother

(

void

)

const

GenerateData()

template<class TFilter >

void otb::PersistentFilterStreamingDecorator< TFilter >::GenerateData ( void  )

overrideprotected

GetFilter()

template<class TFilter >

virtual const FilterType* otb::PersistentFilterStreamingDecorator< TFilter >::GetFilter ( ) const

virtual

GetNameOfClass()

template<class TFilter >

virtual const char* otb::PersistentFilterStreamingDecorator< TFilter >::GetNameOfClass ( ) const

virtual

Creation through object factory macro

itkGetObjectMacro() [1/2]

template<class TFilter >

otb::PersistentFilterStreamingDecorator< TFilter >::itkGetObjectMacro	(	Filter	,
		FilterType
	)

itkGetObjectMacro() [2/2]

template<class TFilter >

otb::PersistentFilterStreamingDecorator< TFilter >::itkGetObjectMacro	(	Streamer	,
		StreamerType
	)

New()

template<class TFilter >

static Pointer otb::PersistentFilterStreamingDecorator< TFilter >::New ( )

static

Type macro

Referenced by otb::LabelImageSmallRegionMergingFilter< TInputLabelImage >::LabelImageSmallRegionMergingFilter().

operator=()

template<class TFilter >

void otb::PersistentFilterStreamingDecorator< TFilter >::operator= ( const Self &  )

privatedelete

PrintSelf()

template<class TFilter >

void otb::PersistentFilterStreamingDecorator< TFilter >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

PrintSelf method

SetFilter()

template<class TFilter >

virtual void otb::PersistentFilterStreamingDecorator< TFilter >::SetFilter ( FilterType *  _arg )

virtual

Update()

template<class TFilter >

void otb::PersistentFilterStreamingDecorator< TFilter >::Update ( void  )

override

Member Data Documentation

m_Filter

template<class TFilter >

FilterPointerType otb::PersistentFilterStreamingDecorator< TFilter >::m_Filter

protected

Object responsible for computation.

Definition at line 95 of file otbPersistentFilterStreamingDecorator.h.

m_Streamer

template<class TFilter >

StreamerPointerType otb::PersistentFilterStreamingDecorator< TFilter >::m_Streamer

protected

Object responsible for streaming.

Definition at line 92 of file otbPersistentFilterStreamingDecorator.h.

---

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

• otbPersistentFilterStreamingDecorator.h