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

#include <otbImageRegionNonUniformMultidimensionalSplitter.h>

+ Inheritance diagram for otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >:
+ Collaboration diagram for otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::Index
< VImageDimension > 
IndexType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ImageRegion
< VImageDimension > 
RegionType
 
typedef
ImageRegionNonUniformMultidimensionalSplitter 
Self
 
typedef itk::Size
< VImageDimension > 
SizeType
 
typedef
itk::ImageRegionSplitter
< VImageDimension > 
Superclass
 
- Public Types inherited from itk::ImageRegionSplitter< VImageDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef Index< VImageDimension > IndexType
 
typedef SmartPointer< SelfPointer
 
typedef ImageRegion
< VImageDimension > 
RegionType
 
typedef ImageRegionSplitter Self
 
typedef Size< VImageDimension > 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
 
RegionType GetSplit (unsigned int i, unsigned int numberOfPieces, const RegionType &region) override
 
- 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 Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageRegionSplitter< VImageDimension >
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 = VImageDimension
 
- Static Public Attributes inherited from itk::ImageRegionSplitter< VImageDimension >
static const unsigned int ImageDimension
 

Protected Member Functions

 ImageRegionNonUniformMultidimensionalSplitter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~ImageRegionNonUniformMultidimensionalSplitter () override
 
- Protected Member Functions inherited from itk::ImageRegionSplitter< VImageDimension >
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

 ImageRegionNonUniformMultidimensionalSplitter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

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

Detailed Description

template<unsigned int VImageDimension>
class otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >

Divide a region into several pieces.

ImageRegionNonUniformMultidimensionalSplitter divides an ImageRegion into smaller regions. ImageRegionNonUniformMultidimensionalSplitter is used by the StreamingImageFilter to divide a requested output region into a series of smaller requests of the pipeline. This object has two basic methods: GetNumberOfSplits() and GetSplit().

GetNumberOfSplits() is used to determine how may subregions a given region can be divided. You call GetNumberOfSplits with an argument that is the number of subregions you want. If the image region can support that number of subregions, that number is returned. Otherwise, the maximum number of splits a region can support will be returned. For example, if a region splitter class only divides a region into horizontal slabs, then the maximum number of splits will be the number of rows in the region.

GetSplit() returns the ith of N subregions (as an ImageRegion object).

ImageRegionNonUniformMultidimensionalSplitter class first proceed to the division according to the last dimension, if the number of required division is not reached, it proceed to divide the dimension before the last one and so on.

Definition at line 66 of file otbImageRegionNonUniformMultidimensionalSplitter.h.

Member Typedef Documentation

template<unsigned int VImageDimension>
typedef itk::SmartPointer<const Self> otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::ConstPointer
template<unsigned int VImageDimension>
typedef itk::Index<VImageDimension> otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::IndexType

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

Definition at line 85 of file otbImageRegionNonUniformMultidimensionalSplitter.h.

template<unsigned int VImageDimension>
typedef itk::SmartPointer<Self> otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::Pointer
template<unsigned int VImageDimension>
typedef itk::ImageRegion<VImageDimension> otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::RegionType

Region typedef support.

Definition at line 91 of file otbImageRegionNonUniformMultidimensionalSplitter.h.

template<unsigned int VImageDimension>
typedef ImageRegionNonUniformMultidimensionalSplitter otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::Self

Standard class typedefs.

Definition at line 70 of file otbImageRegionNonUniformMultidimensionalSplitter.h.

template<unsigned int VImageDimension>
typedef itk::Size<VImageDimension> otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::SizeType

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

Definition at line 88 of file otbImageRegionNonUniformMultidimensionalSplitter.h.

template<unsigned int VImageDimension>
typedef itk::ImageRegionSplitter<VImageDimension> otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::Superclass

Constructor & Destructor Documentation

template<unsigned int VImageDimension>
otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::ImageRegionNonUniformMultidimensionalSplitter ( )
inlineprotected
template<unsigned int VImageDimension>
otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::~ImageRegionNonUniformMultidimensionalSplitter ( )
inlineoverrideprotected
template<unsigned int VImageDimension>
otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::ImageRegionNonUniformMultidimensionalSplitter ( const Self )
privatedelete

Member Function Documentation

template<unsigned int VImageDimension>
virtual::itk::LightObject::Pointer otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::CreateAnother ( void  ) const
virtual
template<unsigned int VImageDimension>
virtual const char* otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageRegionSplitter< VImageDimension >.

template<unsigned int VImageDimension>
unsigned int otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetNumberOfSplits ( const RegionType region,
unsigned int  requestedNumber 
)
overridevirtual

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. This method returns a number less than or equal to the requested number of pieces.

Reimplemented from itk::ImageRegionSplitter< VImageDimension >.

Definition at line 35 of file otbImageRegionNonUniformMultidimensionalSplitter.hxx.

References ceil(), and itk::ImageRegion< VImageDimension >::GetSize().

template<unsigned int VImageDimension>
itk::ImageRegion< VImageDimension > otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetSplit ( unsigned int  i,
unsigned int  numberOfPieces,
const RegionType region 
)
overridevirtual

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.

Reimplemented from itk::ImageRegionSplitter< VImageDimension >.

Definition at line 87 of file otbImageRegionNonUniformMultidimensionalSplitter.hxx.

References ceil(), itk::ImageRegion< VImageDimension >::GetIndex(), itk::ImageRegion< VImageDimension >::GetSize(), itk::ImageRegion< VImageDimension >::SetIndex(), and itk::ImageRegion< VImageDimension >::SetSize().

template<unsigned int VImageDimension>
static Pointer otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::New ( )
static

Method for creation through the object factory.

template<unsigned int VImageDimension>
void otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::operator= ( const Self )
privatedelete
template<unsigned int VImageDimension>
void otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Member Data Documentation

template<unsigned int VImageDimension>
const unsigned int otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::ImageDimension = VImageDimension
static

Dimension of the image available at compile time.

Definition at line 82 of file otbImageRegionNonUniformMultidimensionalSplitter.h.


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