OTB  9.0.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::RAMDrivenTiledStreamingManager< TImage > Class Template Reference

#include <otbRAMDrivenTiledStreamingManager.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TImage ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::RegionType RegionType
 
typedef RAMDrivenTiledStreamingManager Self
 
typedef StreamingManager< TImage > Superclass
 
- Public Types inherited from otb::StreamingManager< TImage >
typedef itk::ImageRegionSplitterBase AbstractSplitterType
 
typedef itk::SmartPointer< const SelfConstPointer
 
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 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 SetDefaultRAM (MemoryPrintType _arg)
 

Static Public Member Functions

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

 RAMDrivenTiledStreamingManager ()
 
 ~RAMDrivenTiledStreamingManager () 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 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
 

Private Member Functions

void operator= (const RAMDrivenTiledStreamingManager &)
 
 RAMDrivenTiledStreamingManager (const RAMDrivenTiledStreamingManager &)
 

Additional Inherited Members

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

Detailed Description

template<class TImage>
class otb::RAMDrivenTiledStreamingManager< TImage >

This class computes the divisions needed to stream an image in square tiles, according to a user-defined available RAM.

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
ImageFileWriter
StreamingImageVirtualFileWriter

Definition at line 43 of file otbRAMDrivenTiledStreamingManager.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 50 of file otbRAMDrivenTiledStreamingManager.h.

◆ ImageType

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

Definition at line 52 of file otbRAMDrivenTiledStreamingManager.h.

◆ Pointer

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

Definition at line 49 of file otbRAMDrivenTiledStreamingManager.h.

◆ RegionType

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

Definition at line 53 of file otbRAMDrivenTiledStreamingManager.h.

◆ Self

template<class TImage >
typedef RAMDrivenTiledStreamingManager otb::RAMDrivenTiledStreamingManager< TImage >::Self

Standard class typedefs.

Definition at line 47 of file otbRAMDrivenTiledStreamingManager.h.

◆ Superclass

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

Definition at line 48 of file otbRAMDrivenTiledStreamingManager.h.

Constructor & Destructor Documentation

◆ RAMDrivenTiledStreamingManager() [1/2]

template<class TImage >
otb::RAMDrivenTiledStreamingManager< TImage >::RAMDrivenTiledStreamingManager
protected

Definition at line 32 of file otbRAMDrivenTiledStreamingManager.hxx.

◆ ~RAMDrivenTiledStreamingManager()

template<class TImage >
otb::RAMDrivenTiledStreamingManager< TImage >::~RAMDrivenTiledStreamingManager
overrideprotected

Definition at line 37 of file otbRAMDrivenTiledStreamingManager.hxx.

◆ RAMDrivenTiledStreamingManager() [2/2]

template<class TImage >
otb::RAMDrivenTiledStreamingManager< TImage >::RAMDrivenTiledStreamingManager ( const RAMDrivenTiledStreamingManager< TImage > &  )
private

Member Function Documentation

◆ CreateAnother()

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

◆ GetAvailableRAMInMB()

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

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

◆ GetBias()

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

The multiplier to apply to the memory print estimation

◆ GetNameOfClass()

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

Type macro

Reimplemented from otb::StreamingManager< TImage >.

◆ New()

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

Creation through object factory macro

◆ operator=()

template<class TImage >
void otb::RAMDrivenTiledStreamingManager< TImage >::operator= ( const RAMDrivenTiledStreamingManager< TImage > &  )
private

◆ PrepareStreaming()

template<class TImage >
void otb::RAMDrivenTiledStreamingManager< TImage >::PrepareStreaming ( itk::DataObject *  input,
const RegionType region 
)
overridevirtual

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

Implements otb::StreamingManager< TImage >.

Definition at line 42 of file otbRAMDrivenTiledStreamingManager.hxx.

References otbMsgDevMacro.

◆ SetAvailableRAMInMB()

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

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

◆ SetBias()

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

The multiplier to apply to the memory print estimation

Member Data Documentation

◆ ImageDimension

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

Dimension of input image.

Definition at line 62 of file otbRAMDrivenTiledStreamingManager.h.

◆ m_AvailableRAMInMB

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

The number of MegaBytes of RAM available

Definition at line 87 of file otbRAMDrivenTiledStreamingManager.h.

◆ m_Bias

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

The multiplier to apply to the memory print estimation

Definition at line 90 of file otbRAMDrivenTiledStreamingManager.h.


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