otb::RAMDrivenStrippedStreamingManager< TImage > Class Template Reference

#include <otbRAMDrivenStrippedStreamingManager.h>

Inheritance diagram for otb::RAMDrivenStrippedStreamingManager< TImage >:

Collaboration diagram for otb::RAMDrivenStrippedStreamingManager< TImage >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef TImage	ImageType
typedef itk::SmartPointer< Self >	Pointer
typedef Superclass::RegionType	RegionType
typedef RAMDrivenStrippedStreamingManager	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< Self >	Pointer
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 AbstractSplitterType *	GetSplitter () 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 Types
typedef itk::ImageRegionSplitter< itkGetStaticConstMacro(ImageDimension)>	SplitterType
Protected Types inherited from otb::StreamingManager< TImage >
typedef AbstractSplitterType::Pointer	AbstractSplitterPointerType

Protected Member Functions
	RAMDrivenStrippedStreamingManager ()
	~RAMDrivenStrippedStreamingManager () 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 RAMDrivenStrippedStreamingManager &)
	RAMDrivenStrippedStreamingManager (const RAMDrivenStrippedStreamingManager &)

Detailed Description

template<class TImage>
class otb::RAMDrivenStrippedStreamingManager< TImage >

This class computes the divisions needed to stream an image by strips, 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 44 of file otbRAMDrivenStrippedStreamingManager.h.

Member Typedef Documentation

ConstPointer

template<class TImage >

typedef itk::SmartPointer<const Self> otb::RAMDrivenStrippedStreamingManager< TImage >::ConstPointer

Definition at line 51 of file otbRAMDrivenStrippedStreamingManager.h.

ImageType

template<class TImage >

typedef TImage otb::RAMDrivenStrippedStreamingManager< TImage >::ImageType

Definition at line 53 of file otbRAMDrivenStrippedStreamingManager.h.

Pointer

template<class TImage >

typedef itk::SmartPointer<Self> otb::RAMDrivenStrippedStreamingManager< TImage >::Pointer

Definition at line 50 of file otbRAMDrivenStrippedStreamingManager.h.

RegionType

template<class TImage >

typedef Superclass::RegionType otb::RAMDrivenStrippedStreamingManager< TImage >::RegionType

Definition at line 54 of file otbRAMDrivenStrippedStreamingManager.h.

Self

template<class TImage >

typedef RAMDrivenStrippedStreamingManager otb::RAMDrivenStrippedStreamingManager< TImage >::Self

Standard class typedefs.

Definition at line 48 of file otbRAMDrivenStrippedStreamingManager.h.

SplitterType

template<class TImage >

typedef itk::ImageRegionSplitter<itkGetStaticConstMacro(ImageDimension)> otb::RAMDrivenStrippedStreamingManager< TImage >::SplitterType

protected

The splitter type used to generate the different strips

Definition at line 88 of file otbRAMDrivenStrippedStreamingManager.h.

Superclass

template<class TImage >

typedef StreamingManager<TImage> otb::RAMDrivenStrippedStreamingManager< TImage >::Superclass

Definition at line 49 of file otbRAMDrivenStrippedStreamingManager.h.

Constructor & Destructor Documentation

RAMDrivenStrippedStreamingManager() [1/2]

template<class TImage >

otb::RAMDrivenStrippedStreamingManager< TImage >::RAMDrivenStrippedStreamingManager

protected

Definition at line 31 of file otbRAMDrivenStrippedStreamingManager.hxx.

~RAMDrivenStrippedStreamingManager()

template<class TImage >

otb::RAMDrivenStrippedStreamingManager< TImage >::~RAMDrivenStrippedStreamingManager

overrideprotected

Definition at line 36 of file otbRAMDrivenStrippedStreamingManager.hxx.

RAMDrivenStrippedStreamingManager() [2/2]

template<class TImage >

otb::RAMDrivenStrippedStreamingManager< TImage >::RAMDrivenStrippedStreamingManager ( const RAMDrivenStrippedStreamingManager< TImage > &  )

private

Member Function Documentation

CreateAnother()

template<class TImage >

virtual::itk::LightObject::Pointer otb::RAMDrivenStrippedStreamingManager< TImage >::CreateAnother

(

void

)

const

GetAvailableRAMInMB()

template<class TImage >

virtual unsigned int otb::RAMDrivenStrippedStreamingManager< TImage >::GetAvailableRAMInMB ( ) const

virtual

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

GetBias()

template<class TImage >

virtual double otb::RAMDrivenStrippedStreamingManager< TImage >::GetBias ( ) const

virtual

The multiplier to apply to the memory print estimation

GetNameOfClass()

template<class TImage >

virtual const char* otb::RAMDrivenStrippedStreamingManager< TImage >::GetNameOfClass ( ) const

virtual

Type macro

Reimplemented from otb::StreamingManager< TImage >.

New()

template<class TImage >

static Pointer otb::RAMDrivenStrippedStreamingManager< TImage >::New ( )

static

Creation through object factory macro

operator=()

template<class TImage >

void otb::RAMDrivenStrippedStreamingManager< TImage >::operator= ( const RAMDrivenStrippedStreamingManager< TImage > &  )

private

PrepareStreaming()

template<class TImage >

void otb::RAMDrivenStrippedStreamingManager< 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 41 of file otbRAMDrivenStrippedStreamingManager.hxx.

SetAvailableRAMInMB()

template<class TImage >

virtual void otb::RAMDrivenStrippedStreamingManager< 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::RAMDrivenStrippedStreamingManager< 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::RAMDrivenStrippedStreamingManager< TImage >::ImageDimension = ImageType::ImageDimension

static

Dimension of input image.

Definition at line 63 of file otbRAMDrivenStrippedStreamingManager.h.

m_AvailableRAMInMB

template<class TImage >

unsigned int otb::RAMDrivenStrippedStreamingManager< TImage >::m_AvailableRAMInMB

protected

The number of MegaBytes of RAM available

Definition at line 91 of file otbRAMDrivenStrippedStreamingManager.h.

m_Bias

template<class TImage >

double otb::RAMDrivenStrippedStreamingManager< TImage >::m_Bias

protected

The multiplier to apply to the memory print estimation

Definition at line 94 of file otbRAMDrivenStrippedStreamingManager.h.

---

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

• otbRAMDrivenStrippedStreamingManager.h
• otbRAMDrivenStrippedStreamingManager.hxx