OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
otb::RAMDrivenAdaptativeStreamingManager< TImage > Class Template Reference

#include <otbRAMDrivenAdaptativeStreamingManager.h>

+ Inheritance diagram for otb::RAMDrivenAdaptativeStreamingManager< TImage >:
+ Collaboration diagram for otb::RAMDrivenAdaptativeStreamingManager< TImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TImage ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::RegionType RegionType
 
typedef
RAMDrivenAdaptativeStreamingManager 
Self
 
typedef StreamingManager< TImage > Superclass
 
- Public Types inherited from otb::StreamingManager< TImage >
typedef
itk::ImageRegionSplitterBase 
AbstractSplitterType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef ImageType::Pointer ImagePointerType
 
typedef TImage ImageType
 
typedef RegionType::IndexType IndexType
 
typedef
otb::PipelineMemoryPrintCalculator::MemoryPrintType 
MemoryPrintType
 
typedef
ImageType::InternalPixelType 
PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageType::RegionType RegionType
 
typedef StreamingManager Self
 
typedef RegionType::SizeType SizeType
 
typedef itk::LightObject 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 unsigned int GetAvailableRAMInMB () const
 
virtual double GetBias () const
 
virtual const char * GetNameOfClass () const
 
void PrepareStreaming (itk::DataObject *input, const RegionType &region) override
 
virtual void SetAvailableRAMInMB (unsigned int _arg)
 
virtual void SetBias (double _arg)
 
- Public Member Functions inherited from otb::StreamingManager< TImage >
virtual MemoryPrintType GetDefaultRAM ()
 
virtual unsigned int GetNumberOfSplits ()
 
virtual RegionType GetSplit (unsigned int i)
 
const AbstractSplitterTypeGetSplitter () const
 
virtual void PrepareStreaming (itk::DataObject *input, const RegionType &region)=0
 
virtual void SetDefaultRAM (MemoryPrintType _arg)
 
- 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 ()
 

Static Public Attributes

static const unsigned int ImageDimension = ImageType::ImageDimension
 
- Static Public Attributes inherited from otb::StreamingManager< TImage >
static const unsigned int ImageDimension = ImageType::ImageDimension
 

Protected Member Functions

 RAMDrivenAdaptativeStreamingManager ()
 
 ~RAMDrivenAdaptativeStreamingManager () override
 
- Protected Member Functions inherited from otb::StreamingManager< TImage >
virtual unsigned int EstimateOptimalNumberOfDivisions (itk::DataObject *input, const RegionType &region, MemoryPrintType availableRAMInMB, double bias=1.0)
 
 StreamingManager ()
 
 ~StreamingManager () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
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

unsigned int m_AvailableRAMInMB
 
double m_Bias
 
- Protected Attributes inherited from otb::StreamingManager< TImage >
unsigned int m_ComputedNumberOfSplits
 
RegionType m_Region
 
AbstractSplitterPointerType m_Splitter
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

void operator= (const RAMDrivenAdaptativeStreamingManager &)
 
 RAMDrivenAdaptativeStreamingManager (const RAMDrivenAdaptativeStreamingManager &)
 

Additional Inherited Members

- Protected Types inherited from otb::StreamingManager< TImage >
typedef
AbstractSplitterType::Pointer 
AbstractSplitterPointerType
 

Detailed Description

template<class TImage>
class otb::RAMDrivenAdaptativeStreamingManager< TImage >

This class computes the divisions needed to stream an image according to the input image tiling scheme and a user-defined available RAM.

This streaming manager uses the TileHint from the MetaDataDictionary to find out the tiling sheme of the input file if available.

You can use SetAvailableRAMInMB to set the available RAM. An estimation of the pipeline memory print will be done, and the number of divisions will then be computed to fit the available RAM.

See Also
ImageRegionAdaptativeSplitter
ImageFileWriter
StreamingImageVirtualFileWriter

Definition at line 49 of file otbRAMDrivenAdaptativeStreamingManager.h.

Member Typedef Documentation

template<class TImage >
typedef itk::SmartPointer<const Self> otb::RAMDrivenAdaptativeStreamingManager< TImage >::ConstPointer

Definition at line 56 of file otbRAMDrivenAdaptativeStreamingManager.h.

template<class TImage >
typedef TImage otb::RAMDrivenAdaptativeStreamingManager< TImage >::ImageType

Definition at line 58 of file otbRAMDrivenAdaptativeStreamingManager.h.

template<class TImage >
typedef itk::SmartPointer<Self> otb::RAMDrivenAdaptativeStreamingManager< TImage >::Pointer

Definition at line 55 of file otbRAMDrivenAdaptativeStreamingManager.h.

template<class TImage >
typedef Superclass::RegionType otb::RAMDrivenAdaptativeStreamingManager< TImage >::RegionType

Definition at line 59 of file otbRAMDrivenAdaptativeStreamingManager.h.

Standard class typedefs.

Definition at line 53 of file otbRAMDrivenAdaptativeStreamingManager.h.

template<class TImage >
typedef StreamingManager<TImage> otb::RAMDrivenAdaptativeStreamingManager< TImage >::Superclass

Definition at line 54 of file otbRAMDrivenAdaptativeStreamingManager.h.

Constructor & Destructor Documentation

template<class TImage >
otb::RAMDrivenAdaptativeStreamingManager< TImage >::RAMDrivenAdaptativeStreamingManager ( )
protected

Definition at line 34 of file otbRAMDrivenAdaptativeStreamingManager.hxx.

template<class TImage >
otb::RAMDrivenAdaptativeStreamingManager< TImage >::~RAMDrivenAdaptativeStreamingManager ( )
overrideprotected

Definition at line 41 of file otbRAMDrivenAdaptativeStreamingManager.hxx.

Member Function Documentation

template<class TImage >
virtual::itk::LightObject::Pointer otb::RAMDrivenAdaptativeStreamingManager< TImage >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TImage >
virtual unsigned int otb::RAMDrivenAdaptativeStreamingManager< TImage >::GetAvailableRAMInMB ( ) const
virtual

The number of Megabytes available (if 0, the configuration option is used)

template<class TImage >
virtual double otb::RAMDrivenAdaptativeStreamingManager< TImage >::GetBias ( ) const
virtual

The multiplier to apply to the memory print estimation

template<class TImage >
virtual const char* otb::RAMDrivenAdaptativeStreamingManager< TImage >::GetNameOfClass ( ) const
virtual

Type macro

Reimplemented from otb::StreamingManager< TImage >.

template<class TImage >
static Pointer otb::RAMDrivenAdaptativeStreamingManager< TImage >::New ( )
static

Creation through object factory macro

template<class TImage >
void otb::RAMDrivenAdaptativeStreamingManager< TImage >::operator= ( const RAMDrivenAdaptativeStreamingManager< TImage > &  )
private
template<class TImage >
void otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming ( itk::DataObject input,
const RegionType region 
)
override

Actually computes the stream divisions, according to the specified streaming mode, eventually using the input parameter to estimate memory consumption

Definition at line 47 of file otbRAMDrivenAdaptativeStreamingManager.hxx.

References itk::Object::GetMetaDataDictionary(), otb::MetaDataKey::TileHintX, and otb::MetaDataKey::TileHintY.

template<class TImage >
virtual void otb::RAMDrivenAdaptativeStreamingManager< TImage >::SetAvailableRAMInMB ( unsigned int  _arg)
virtual

The number of Megabytes available (if 0, the configuration option is used)

template<class TImage >
virtual void otb::RAMDrivenAdaptativeStreamingManager< TImage >::SetBias ( double  _arg)
virtual

The multiplier to apply to the memory print estimation

Member Data Documentation

template<class TImage >
const unsigned int otb::RAMDrivenAdaptativeStreamingManager< TImage >::ImageDimension = ImageType::ImageDimension
static

Dimension of input image.

Definition at line 68 of file otbRAMDrivenAdaptativeStreamingManager.h.

template<class TImage >
unsigned int otb::RAMDrivenAdaptativeStreamingManager< TImage >::m_AvailableRAMInMB
protected

The number of MegaBytes of RAM available

Definition at line 93 of file otbRAMDrivenAdaptativeStreamingManager.h.

template<class TImage >
double otb::RAMDrivenAdaptativeStreamingManager< TImage >::m_Bias
protected

The multiplier to apply to the memory print estimation

Definition at line 96 of file otbRAMDrivenAdaptativeStreamingManager.h.


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