OTB  9.0.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 SelfConstPointer
 
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 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
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = VImageDimension
 

Protected Member Functions

 ImageRegionNonUniformMultidimensionalSplitter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~ImageRegionNonUniformMultidimensionalSplitter () override
 

Private Member Functions

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

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

◆ ConstPointer

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

◆ IndexType

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.

◆ Pointer

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

◆ RegionType

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

Region typedef support.

Definition at line 91 of file otbImageRegionNonUniformMultidimensionalSplitter.h.

◆ Self

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

Standard class typedefs.

Definition at line 70 of file otbImageRegionNonUniformMultidimensionalSplitter.h.

◆ SizeType

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.

◆ Superclass

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

Constructor & Destructor Documentation

◆ ImageRegionNonUniformMultidimensionalSplitter() [1/2]

template<unsigned int VImageDimension>
otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::ImageRegionNonUniformMultidimensionalSplitter ( )
inlineprotected

◆ ~ImageRegionNonUniformMultidimensionalSplitter()

template<unsigned int VImageDimension>
otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::~ImageRegionNonUniformMultidimensionalSplitter ( )
inlineoverrideprotected

◆ ImageRegionNonUniformMultidimensionalSplitter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetNameOfClass()

template<unsigned int VImageDimension>
virtual const char* otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ GetNumberOfSplits()

template<unsigned int VImageDimension>
unsigned int otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::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. This method returns a number less than or equal to the requested number of pieces.

Definition at line 33 of file otbImageRegionNonUniformMultidimensionalSplitter.hxx.

◆ GetSplit()

template<unsigned int VImageDimension>
itk::ImageRegion< VImageDimension > otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::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.

Definition at line 82 of file otbImageRegionNonUniformMultidimensionalSplitter.hxx.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

template<unsigned int VImageDimension>
void otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::operator= ( const Self )
privatedelete

◆ PrintSelf()

template<unsigned int VImageDimension>
void otb::ImageRegionNonUniformMultidimensionalSplitter< VImageDimension >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Member Data Documentation

◆ ImageDimension

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: