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

#include <otbNumberOfLinesStrippedStreamingManager.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TImage ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::RegionType RegionType
 
typedef NumberOfLinesStrippedStreamingManager 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 const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfLinesPerStrip ()
 
void PrepareStreaming (itk::DataObject *, const RegionType &region) override
 
virtual void SetNumberOfLinesPerStrip (unsigned int _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 Types

typedef itk::ImageRegionSplitter< itkGetStaticConstMacro(ImageDimension)> SplitterType
 
- Protected Types inherited from otb::StreamingManager< TImage >
typedef AbstractSplitterType::Pointer AbstractSplitterPointerType
 

Protected Member Functions

 NumberOfLinesStrippedStreamingManager ()
 
 ~NumberOfLinesStrippedStreamingManager () 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_NumberOfLinesPerStrip
 
- Protected Attributes inherited from otb::StreamingManager< TImage >
unsigned int m_ComputedNumberOfSplits
 
RegionType m_Region
 
AbstractSplitterPointerType m_Splitter
 

Private Member Functions

 NumberOfLinesStrippedStreamingManager (const NumberOfLinesStrippedStreamingManager &)
 
void operator= (const NumberOfLinesStrippedStreamingManager &)
 

Detailed Description

template<class TImage>
class otb::NumberOfLinesStrippedStreamingManager< TImage >

This class computes the divisions needed to stream an image by strips, driven by a user-defined desired number of lines per strips.

You can use SetNumberOfLinesPerStrip to ask for a specific number of lines per strip. The number of strips will be computed to fit this requirements as close as possible.

See also
ImageFileWriter
StreamingImageVirtualFileWriter

Definition at line 43 of file otbNumberOfLinesStrippedStreamingManager.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 50 of file otbNumberOfLinesStrippedStreamingManager.h.

◆ ImageType

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

Definition at line 52 of file otbNumberOfLinesStrippedStreamingManager.h.

◆ Pointer

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

Definition at line 49 of file otbNumberOfLinesStrippedStreamingManager.h.

◆ RegionType

Definition at line 53 of file otbNumberOfLinesStrippedStreamingManager.h.

◆ Self

Standard class typedefs.

Definition at line 47 of file otbNumberOfLinesStrippedStreamingManager.h.

◆ SplitterType

template<class TImage >
typedef itk::ImageRegionSplitter<itkGetStaticConstMacro(ImageDimension)> otb::NumberOfLinesStrippedStreamingManager< TImage >::SplitterType
protected

The splitter type used to generate the different strips

Definition at line 79 of file otbNumberOfLinesStrippedStreamingManager.h.

◆ Superclass

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

Definition at line 48 of file otbNumberOfLinesStrippedStreamingManager.h.

Constructor & Destructor Documentation

◆ NumberOfLinesStrippedStreamingManager() [1/2]

Definition at line 31 of file otbNumberOfLinesStrippedStreamingManager.hxx.

◆ ~NumberOfLinesStrippedStreamingManager()

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

Definition at line 36 of file otbNumberOfLinesStrippedStreamingManager.hxx.

◆ NumberOfLinesStrippedStreamingManager() [2/2]

Member Function Documentation

◆ CreateAnother()

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

◆ GetNameOfClass()

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

Type macro

Reimplemented from otb::StreamingManager< TImage >.

◆ GetNumberOfLinesPerStrip()

template<class TImage >
virtual unsigned int otb::NumberOfLinesStrippedStreamingManager< TImage >::GetNumberOfLinesPerStrip ( )
virtual

The number of lines per strip desired

◆ New()

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

Creation through object factory macro

◆ operator=()

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

◆ PrepareStreaming()

template<class TImage >
void otb::NumberOfLinesStrippedStreamingManager< TImage >::PrepareStreaming ( itk::DataObject *  ,
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 otbNumberOfLinesStrippedStreamingManager.hxx.

References otbMsgDevMacro.

◆ SetNumberOfLinesPerStrip()

template<class TImage >
virtual void otb::NumberOfLinesStrippedStreamingManager< TImage >::SetNumberOfLinesPerStrip ( unsigned int  _arg)
virtual

The number of lines per strip desired

Member Data Documentation

◆ ImageDimension

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

Dimension of input image.

Definition at line 62 of file otbNumberOfLinesStrippedStreamingManager.h.

◆ m_NumberOfLinesPerStrip

template<class TImage >
unsigned int otb::NumberOfLinesStrippedStreamingManager< TImage >::m_NumberOfLinesPerStrip
protected

The number of lines per strip desired by the user. This may be different than the one computed by the Splitter

Definition at line 83 of file otbNumberOfLinesStrippedStreamingManager.h.


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