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

#include <otbNumberOfDivisionsStrippedStreamingManager.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef TImage ImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::RegionType RegionType
 
typedef
NumberOfDivisionsStrippedStreamingManager 
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 const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfDivisions ()
 
void PrepareStreaming (itk::DataObject *, const RegionType &region) override
 
virtual void SetNumberOfDivisions (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 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 Types

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

Protected Member Functions

 NumberOfDivisionsStrippedStreamingManager ()
 
 ~NumberOfDivisionsStrippedStreamingManager () 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 ()
 
unsigned int m_NumberOfDivisions
 
 NumberOfDivisionsStrippedStreamingManager (const NumberOfDivisionsStrippedStreamingManager &)
 
void operator= (const NumberOfDivisionsStrippedStreamingManager &)
 

Additional Inherited Members

- 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
 

Detailed Description

template<class TImage>
class otb::NumberOfDivisionsStrippedStreamingManager< TImage >

This class computes the divisions needed to stream an image by strips, driven by a user-defined number of divisions in which to divide the images.

You can use SetNumberOfDivisions to ask for a specific number of divisions. 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 otbNumberOfDivisionsStrippedStreamingManager.h.

Member Typedef Documentation

template<class TImage >
typedef itk::SmartPointer<const Self> otb::NumberOfDivisionsStrippedStreamingManager< TImage >::ConstPointer
template<class TImage >
typedef TImage otb::NumberOfDivisionsStrippedStreamingManager< TImage >::ImageType
template<class TImage >
typedef Superclass::RegionType otb::NumberOfDivisionsStrippedStreamingManager< TImage >::RegionType

Standard class typedefs.

Definition at line 47 of file otbNumberOfDivisionsStrippedStreamingManager.h.

The splitter type used to generate the different strips

Definition at line 78 of file otbNumberOfDivisionsStrippedStreamingManager.h.

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

Constructor & Destructor Documentation

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

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

Member Function Documentation

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

Reimplemented from itk::Object.

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

Type macro

Reimplemented from otb::StreamingManager< TImage >.

template<class TImage >
virtual unsigned int otb::NumberOfDivisionsStrippedStreamingManager< TImage >::GetNumberOfDivisions ( )
virtual

The number of lines per strip desired

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

Creation through object factory macro

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

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

template<class TImage >
void otb::NumberOfDivisionsStrippedStreamingManager< TImage >::PrepareStreaming ( itk::DataObject ,
const RegionType region 
)
override

Actually computes the stream divisions given a DataObject and its region to write

Definition at line 43 of file otbNumberOfDivisionsStrippedStreamingManager.hxx.

References itk::ImageRegionSplitterSlowDimension::New(), and otbMsgDevMacro.

template<class TImage >
virtual void otb::NumberOfDivisionsStrippedStreamingManager< TImage >::SetNumberOfDivisions ( unsigned int  _arg)
virtual

The number of lines per strip desired

Member Data Documentation

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

Dimension of input image.

Definition at line 62 of file otbNumberOfDivisionsStrippedStreamingManager.h.

template<class TImage >
unsigned int otb::NumberOfDivisionsStrippedStreamingManager< TImage >::m_NumberOfDivisions
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 82 of file otbNumberOfDivisionsStrippedStreamingManager.h.


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