OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::StreamingShrinkImageRegionSplitter Class Reference

#include <otbStreamingShrinkImageFilter.h>

+ Inheritance diagram for otb::StreamingShrinkImageRegionSplitter:
+ Collaboration diagram for otb::StreamingShrinkImageRegionSplitter:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::Index
< ImageDimension
IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ImageRegion
< ImageDimension
RegionType
 
typedef
StreamingShrinkImageRegionSplitter 
Self
 
typedef itk::Size< ImageDimensionSizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef
itk::ImageRegionSplitter< 2 > 
Superclass
 
- Public Types inherited from itk::ImageRegionSplitter< 2 >
typedef SmartPointer< const SelfConstPointer
 
typedef Index< 2 > IndexType
 
typedef SmartPointer< SelfPointer
 
typedef ImageRegion< 2 > RegionType
 
typedef ImageRegionSplitter Self
 
typedef Size< 2 > SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef ImageRegionSplitterBase Superclass
 
- Public Types inherited from itk::ImageRegionSplitterBase
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef ImageRegionSplitterBase Self
 
typedef Object 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
 
unsigned int GetNumberOfSplits (const RegionType &region, unsigned int requestedNumber) override
 
virtual unsigned int GetShrinkFactor ()
 
RegionType GetSplit (unsigned int i, unsigned int numberOfPieces, const RegionType &region) override
 
virtual unsigned int GetTileDimension ()
 
virtual unsigned int GetTileSizeAlignment ()
 
virtual void SetShrinkFactor (unsigned int _arg)
 
- Public Member Functions inherited from itk::ImageRegionSplitter< 2 >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual unsigned int GetNumberOfSplits (const RegionType &region, unsigned int requestedNumber)
 
virtual RegionType GetSplit (unsigned int i, unsigned int numberOfPieces, const RegionType &region)
 
- Public Member Functions inherited from itk::ImageRegionSplitterBase
unsigned int GetNumberOfSplits (const ImageIORegion &region, unsigned int requestedNumber) const
 
unsigned int GetNumberOfSplits (const ImageRegion< VImageDimension > &region, unsigned int requestedNumber) const
 
unsigned int GetSplit (unsigned int i, unsigned int numberOfPieces, ImageIORegion &region) const
 
unsigned int GetSplit (unsigned int i, unsigned int numberOfPieces, ImageRegion< VImageDimension > &region) const
 
- 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 unsigned int GetImageDimension ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageRegionSplitter< 2 >
static unsigned int GetImageDimension ()
 
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 = 2
 
- Static Public Attributes inherited from itk::ImageRegionSplitter< 2 >
static const unsigned int ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 StreamingShrinkImageRegionSplitter ()
 
 ~StreamingShrinkImageRegionSplitter () override
 
- Protected Member Functions inherited from itk::ImageRegionSplitter< 2 >
virtual unsigned int GetNumberOfSplitsInternal (unsigned int, const IndexValueType regionIndex[], const SizeValueType regionSize[], unsigned int requestedNumber) const override
 
virtual unsigned int GetSplitInternal (unsigned int dim, unsigned int i, unsigned int numberOfPieces, IndexValueType regionIndex[], SizeValueType regionSize[]) const override
 
 ImageRegionSplitter ()
 
 ~ImageRegionSplitter ()
 
- Protected Member Functions inherited from itk::ImageRegionSplitterBase
 ImageRegionSplitterBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 ()
 

Private Member Functions

void operator= (const StreamingShrinkImageRegionSplitter &)=delete
 
 StreamingShrinkImageRegionSplitter (const StreamingShrinkImageRegionSplitter &)=delete
 

Private Attributes

unsigned int m_ShrinkFactor
 
itk::FixedArray< unsigned int,
ImageDimension
m_SplitsPerDimension
 
unsigned int m_TileDimension
 
unsigned int m_TileSizeAlignment
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

Definition at line 34 of file otbStreamingShrinkImageFilter.h.

Member Typedef Documentation

Definition at line 41 of file otbStreamingShrinkImageFilter.h.

Index typedef support. An index is used to access pixel values.

Definition at line 59 of file otbStreamingShrinkImageFilter.h.

Definition at line 60 of file otbStreamingShrinkImageFilter.h.

Definition at line 40 of file otbStreamingShrinkImageFilter.h.

Region typedef support.

Definition at line 67 of file otbStreamingShrinkImageFilter.h.

Standard class typedefs.

Definition at line 38 of file otbStreamingShrinkImageFilter.h.

Size typedef support. A size is used to define region bounds.

Definition at line 63 of file otbStreamingShrinkImageFilter.h.

Definition at line 64 of file otbStreamingShrinkImageFilter.h.

Definition at line 39 of file otbStreamingShrinkImageFilter.h.

Constructor & Destructor Documentation

otb::StreamingShrinkImageRegionSplitter::StreamingShrinkImageRegionSplitter ( )
inlineprotected

Definition at line 91 of file otbStreamingShrinkImageFilter.h.

otb::StreamingShrinkImageRegionSplitter::~StreamingShrinkImageRegionSplitter ( )
inlineoverrideprotected

Definition at line 92 of file otbStreamingShrinkImageFilter.h.

otb::StreamingShrinkImageRegionSplitter::StreamingShrinkImageRegionSplitter ( const StreamingShrinkImageRegionSplitter )
privatedelete

Member Function Documentation

virtual::itk::LightObject::Pointer otb::StreamingShrinkImageRegionSplitter::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

static unsigned int otb::StreamingShrinkImageRegionSplitter::GetImageDimension ( )
inlinestatic

Dimension of the image available at run time.

Definition at line 53 of file otbStreamingShrinkImageFilter.h.

virtual const char* otb::StreamingShrinkImageRegionSplitter::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageRegionSplitter< 2 >.

unsigned int otb::StreamingShrinkImageRegionSplitter::GetNumberOfSplits ( const RegionType region,
unsigned int  requestedNumber 
)
override

How many pieces can the specified region be split? A given region cannot always be divided into the requested number of pieces. For instance, if the numberOfPieces exceeds the number of pixels along a certain dimensions, then some splits will not be possible.

virtual unsigned int otb::StreamingShrinkImageRegionSplitter::GetShrinkFactor ( )
virtual
RegionType otb::StreamingShrinkImageRegionSplitter::GetSplit ( unsigned int  i,
unsigned int  numberOfPieces,
const RegionType region 
)
override

Get a region definition that represents the ith piece a specified region. The "numberOfPieces" specified should be less than or equal to what GetNumberOfSplits() returns.

virtual unsigned int otb::StreamingShrinkImageRegionSplitter::GetTileDimension ( )
virtual
virtual unsigned int otb::StreamingShrinkImageRegionSplitter::GetTileSizeAlignment ( )
virtual
static Pointer otb::StreamingShrinkImageRegionSplitter::New ( )
static

Method for creation through the object factory.

void otb::StreamingShrinkImageRegionSplitter::operator= ( const StreamingShrinkImageRegionSplitter )
privatedelete
void otb::StreamingShrinkImageRegionSplitter::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::ImageRegionSplitter< 2 >.

virtual void otb::StreamingShrinkImageRegionSplitter::SetShrinkFactor ( unsigned int  _arg)
virtual

Member Data Documentation

const unsigned int otb::StreamingShrinkImageRegionSplitter::ImageDimension = 2
static

Dimension of the image available at compile time.

Definition at line 50 of file otbStreamingShrinkImageFilter.h.

unsigned int otb::StreamingShrinkImageRegionSplitter::m_ShrinkFactor
private

Definition at line 102 of file otbStreamingShrinkImageFilter.h.

itk::FixedArray<unsigned int, ImageDimension> otb::StreamingShrinkImageRegionSplitter::m_SplitsPerDimension
private

Definition at line 99 of file otbStreamingShrinkImageFilter.h.

unsigned int otb::StreamingShrinkImageRegionSplitter::m_TileDimension
private

Definition at line 100 of file otbStreamingShrinkImageFilter.h.

unsigned int otb::StreamingShrinkImageRegionSplitter::m_TileSizeAlignment
private

Definition at line 101 of file otbStreamingShrinkImageFilter.h.


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