OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
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< SelfPointer
 
typedef
PersistentFilterStreamingDecorator 
Self
 
typedef StreamerType::Pointer StreamerPointerType
 
typedef
StreamingImageVirtualWriter
< ImageType
StreamerType
 
typedef itk::ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const FilterTypeGetFilter () const
 
virtual const char * GetNameOfClass () const
 
 itkGetObjectMacro (Filter, FilterType)
 
 itkGetObjectMacro (Streamer, StreamerType)
 
virtual void SetFilter (FilterType *_arg)
 
void Update (void) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void GenerateData (void) override
 
 PersistentFilterStreamingDecorator ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~PersistentFilterStreamingDecorator () override
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

FilterPointerType m_Filter
 
StreamerPointerType m_Streamer
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

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

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

Definition at line 55 of file otbPersistentFilterStreamingDecorator.h.

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

Definition at line 65 of file otbPersistentFilterStreamingDecorator.h.

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

Template parameters typedefs

Definition at line 61 of file otbPersistentFilterStreamingDecorator.h.

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

Definition at line 66 of file otbPersistentFilterStreamingDecorator.h.

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

Definition at line 54 of file otbPersistentFilterStreamingDecorator.h.

Standard typedefs

Definition at line 52 of file otbPersistentFilterStreamingDecorator.h.

Definition at line 69 of file otbPersistentFilterStreamingDecorator.h.

Definition at line 68 of file otbPersistentFilterStreamingDecorator.h.

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

Definition at line 53 of file otbPersistentFilterStreamingDecorator.h.

Constructor & Destructor Documentation

template<class TFilter>
otb::PersistentFilterStreamingDecorator< TFilter >::PersistentFilterStreamingDecorator ( )
protected

Constructor

template<class TFilter>
otb::PersistentFilterStreamingDecorator< TFilter >::~PersistentFilterStreamingDecorator ( )
inlineoverrideprotected

Destructor

Definition at line 83 of file otbPersistentFilterStreamingDecorator.h.

template<class TFilter>
otb::PersistentFilterStreamingDecorator< TFilter >::PersistentFilterStreamingDecorator ( const Self )
privatedelete

Member Function Documentation

template<class TFilter>
virtual::itk::LightObject::Pointer otb::PersistentFilterStreamingDecorator< TFilter >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TFilter>
void otb::PersistentFilterStreamingDecorator< TFilter >::GenerateData ( void  )
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

template<class TFilter>
virtual const FilterType* otb::PersistentFilterStreamingDecorator< TFilter >::GetFilter ( ) const
virtual
template<class TFilter>
virtual const char* otb::PersistentFilterStreamingDecorator< TFilter >::GetNameOfClass ( ) const
virtual
template<class TFilter>
otb::PersistentFilterStreamingDecorator< TFilter >::itkGetObjectMacro ( Filter  ,
FilterType   
)
template<class TFilter>
otb::PersistentFilterStreamingDecorator< TFilter >::itkGetObjectMacro ( Streamer  ,
StreamerType   
)
template<class TFilter>
static Pointer otb::PersistentFilterStreamingDecorator< TFilter >::New ( )
static

Type macro

template<class TFilter>
void otb::PersistentFilterStreamingDecorator< TFilter >::operator= ( const Self )
privatedelete
template<class TFilter>
void otb::PersistentFilterStreamingDecorator< TFilter >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

PrintSelf method

Reimplemented from itk::ProcessObject.

template<class TFilter>
virtual void otb::PersistentFilterStreamingDecorator< TFilter >::SetFilter ( FilterType _arg)
virtual
template<class TFilter>
void otb::PersistentFilterStreamingDecorator< TFilter >::Update ( void  )
overridevirtual

Reimplemented from itk::ProcessObject.

Member Data Documentation

template<class TFilter>
FilterPointerType otb::PersistentFilterStreamingDecorator< TFilter >::m_Filter
protected

Object responsible for computation.

Definition at line 94 of file otbPersistentFilterStreamingDecorator.h.

template<class TFilter>
StreamerPointerType otb::PersistentFilterStreamingDecorator< TFilter >::m_Streamer
protected

Object responsible for streaming.

Definition at line 91 of file otbPersistentFilterStreamingDecorator.h.


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