otb::ImageRegionTileMapSplitter< VImageDimension > Class Template Reference

#include <otbImageRegionTileMapSplitter.h>

Inheritance diagram for otb::ImageRegionTileMapSplitter< VImageDimension >:

Collaboration diagram for otb::ImageRegionTileMapSplitter< VImageDimension >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::Index< VImageDimension >	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef itk::SmartPointer< Self >	Pointer
typedef itk::ImageRegion< VImageDimension >	RegionType
typedef ImageRegionTileMapSplitter	Self
typedef itk::Size< VImageDimension >	SizeType
typedef SizeType::SizeValueType	SizeValueType
typedef itk::ImageRegionSplitter< VImageDimension >	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

Static Public Member Functions
static unsigned int	GetImageDimension ()
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = VImageDimension

Protected Member Functions
	ImageRegionTileMapSplitter ()
	~ImageRegionTileMapSplitter () override

Private Member Functions
	ImageRegionTileMapSplitter (const ImageRegionTileMapSplitter &)=delete
void	operator= (const ImageRegionTileMapSplitter &)=delete

Private Attributes
unsigned int	m_AlignStep
unsigned int	m_SplitsPerDimension [VImageDimension]
unsigned int	GetNumberOfSplits (const RegionType &region, unsigned int requestedNumber) override
RegionType	GetSplit (unsigned int i, unsigned int numberOfPieces, const RegionType &region) override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Detailed Description

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

Divide a region into several pieces.

ImageRegionTileMapSplitter divides an ImageRegion into smaller regions. ImageRegionTileMapSplitter 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).

This ImageRegionTileMapSplitter class divides a region along the outermost dimension. If the outermost dimension has size 1 (i.e. a volume with a single slice), the ImageRegionTileMapSplitter will divide the region along the next outermost dimension. If that dimension has size 1, the process continues with the next outermost dimension.

Regions obtained by the ImageRegionTileMapSplitter are aligned on a grid with width of 256. Divisions can occur only at line defined as k*256.

Other ImageRegionTileMapSplitter subclasses could divide an image into more uniform shaped regions instead of slabs.

See also

ImageRegionMultidimensionalSplitter

Definition at line 75 of file otbImageRegionTileMapSplitter.h.

Member Typedef Documentation

ConstPointer

template<unsigned int VImageDimension>

typedef itk::SmartPointer<const Self> otb::ImageRegionTileMapSplitter< VImageDimension >::ConstPointer

Definition at line 82 of file otbImageRegionTileMapSplitter.h.

IndexType

template<unsigned int VImageDimension>

typedef itk::Index<VImageDimension> otb::ImageRegionTileMapSplitter< VImageDimension >::IndexType

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

Definition at line 100 of file otbImageRegionTileMapSplitter.h.

IndexValueType

template<unsigned int VImageDimension>

typedef IndexType::IndexValueType otb::ImageRegionTileMapSplitter< VImageDimension >::IndexValueType

Definition at line 101 of file otbImageRegionTileMapSplitter.h.

Pointer

template<unsigned int VImageDimension>

typedef itk::SmartPointer<Self> otb::ImageRegionTileMapSplitter< VImageDimension >::Pointer

Definition at line 81 of file otbImageRegionTileMapSplitter.h.

RegionType

template<unsigned int VImageDimension>

typedef itk::ImageRegion<VImageDimension> otb::ImageRegionTileMapSplitter< VImageDimension >::RegionType

Region typedef support.

Definition at line 108 of file otbImageRegionTileMapSplitter.h.

Self

template<unsigned int VImageDimension>

typedef ImageRegionTileMapSplitter otb::ImageRegionTileMapSplitter< VImageDimension >::Self

Standard class typedefs.

Definition at line 79 of file otbImageRegionTileMapSplitter.h.

SizeType

template<unsigned int VImageDimension>

typedef itk::Size<VImageDimension> otb::ImageRegionTileMapSplitter< VImageDimension >::SizeType

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

Definition at line 104 of file otbImageRegionTileMapSplitter.h.

SizeValueType

template<unsigned int VImageDimension>

typedef SizeType::SizeValueType otb::ImageRegionTileMapSplitter< VImageDimension >::SizeValueType

Definition at line 105 of file otbImageRegionTileMapSplitter.h.

Superclass

template<unsigned int VImageDimension>

typedef itk::ImageRegionSplitter<VImageDimension> otb::ImageRegionTileMapSplitter< VImageDimension >::Superclass

Definition at line 80 of file otbImageRegionTileMapSplitter.h.

Constructor & Destructor Documentation

ImageRegionTileMapSplitter() [1/2]

template<unsigned int VImageDimension>

otb::ImageRegionTileMapSplitter< VImageDimension >::ImageRegionTileMapSplitter ( )

inlineprotected

Definition at line 124 of file otbImageRegionTileMapSplitter.h.

~ImageRegionTileMapSplitter()

template<unsigned int VImageDimension>

otb::ImageRegionTileMapSplitter< VImageDimension >::~ImageRegionTileMapSplitter ( )

inlineoverrideprotected

Definition at line 127 of file otbImageRegionTileMapSplitter.h.

ImageRegionTileMapSplitter() [2/2]

template<unsigned int VImageDimension>

otb::ImageRegionTileMapSplitter< VImageDimension >::ImageRegionTileMapSplitter ( const ImageRegionTileMapSplitter< VImageDimension > &  )

privatedelete

Member Function Documentation

CreateAnother()

template<unsigned int VImageDimension>

virtual::itk::LightObject::Pointer otb::ImageRegionTileMapSplitter< VImageDimension >::CreateAnother

(

void

)

const

GetImageDimension()

template<unsigned int VImageDimension>

static unsigned int otb::ImageRegionTileMapSplitter< VImageDimension >::GetImageDimension ( )

inlinestatic

Dimension of the image available at run time.

Definition at line 94 of file otbImageRegionTileMapSplitter.h.

GetNameOfClass()

template<unsigned int VImageDimension>

virtual const char* otb::ImageRegionTileMapSplitter< VImageDimension >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetNumberOfSplits()

template<unsigned int VImageDimension>

unsigned int otb::ImageRegionTileMapSplitter< 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 35 of file otbImageRegionTileMapSplitter.hxx.

GetSplit()

template<unsigned int VImageDimension>

itk::ImageRegion< VImageDimension > otb::ImageRegionTileMapSplitter< 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 73 of file otbImageRegionTileMapSplitter.hxx.

New()

template<unsigned int VImageDimension>

static Pointer otb::ImageRegionTileMapSplitter< VImageDimension >::New ( )

static

Method for creation through the object factory.

operator=()

template<unsigned int VImageDimension>

void otb::ImageRegionTileMapSplitter< VImageDimension >::operator= ( const ImageRegionTileMapSplitter< VImageDimension > &  )

privatedelete

PrintSelf()

template<unsigned int VImageDimension>

void otb::ImageRegionTileMapSplitter< VImageDimension >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

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 135 of file otbImageRegionTileMapSplitter.hxx.

Member Data Documentation

ImageDimension

template<unsigned int VImageDimension>

const unsigned int otb::ImageRegionTileMapSplitter< VImageDimension >::ImageDimension = VImageDimension

static

Dimension of the image available at compile time.

Definition at line 91 of file otbImageRegionTileMapSplitter.h.

m_AlignStep

template<unsigned int VImageDimension>

unsigned int otb::ImageRegionTileMapSplitter< VImageDimension >::m_AlignStep

private

Definition at line 137 of file otbImageRegionTileMapSplitter.h.

m_SplitsPerDimension

template<unsigned int VImageDimension>

unsigned int otb::ImageRegionTileMapSplitter< VImageDimension >::m_SplitsPerDimension[VImageDimension]

private

Definition at line 136 of file otbImageRegionTileMapSplitter.h.

---

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

• otbImageRegionTileMapSplitter.h
• otbImageRegionTileMapSplitter.hxx