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< Self >	Pointer
typedef itk::ImageRegion< ImageDimension >	RegionType
typedef StreamingShrinkImageRegionSplitter	Self
typedef itk::Size< ImageDimension >	SizeType
typedef SizeType::SizeValueType	SizeValueType
typedef itk::ImageRegionSplitter< 2 >	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
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)

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

Static Public Attributes
static const unsigned int	ImageDimension = 2

Protected Member Functions
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	StreamingShrinkImageRegionSplitter ()
	~StreamingShrinkImageRegionSplitter () override

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

Detailed Description

Definition at line 34 of file otbStreamingShrinkImageFilter.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> otb::StreamingShrinkImageRegionSplitter::ConstPointer

Definition at line 41 of file otbStreamingShrinkImageFilter.h.

IndexType

typedef itk::Index<ImageDimension> otb::StreamingShrinkImageRegionSplitter::IndexType

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

Definition at line 59 of file otbStreamingShrinkImageFilter.h.

IndexValueType

typedef IndexType::IndexValueType otb::StreamingShrinkImageRegionSplitter::IndexValueType

Definition at line 60 of file otbStreamingShrinkImageFilter.h.

Pointer

typedef itk::SmartPointer<Self> otb::StreamingShrinkImageRegionSplitter::Pointer

Definition at line 40 of file otbStreamingShrinkImageFilter.h.

RegionType

typedef itk::ImageRegion<ImageDimension> otb::StreamingShrinkImageRegionSplitter::RegionType

Region typedef support.

Definition at line 67 of file otbStreamingShrinkImageFilter.h.

Self

typedef StreamingShrinkImageRegionSplitter otb::StreamingShrinkImageRegionSplitter::Self

Standard class typedefs.

Definition at line 38 of file otbStreamingShrinkImageFilter.h.

SizeType

typedef itk::Size<ImageDimension> otb::StreamingShrinkImageRegionSplitter::SizeType

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

Definition at line 63 of file otbStreamingShrinkImageFilter.h.

SizeValueType

typedef SizeType::SizeValueType otb::StreamingShrinkImageRegionSplitter::SizeValueType

Definition at line 64 of file otbStreamingShrinkImageFilter.h.

Superclass

typedef itk::ImageRegionSplitter<2> otb::StreamingShrinkImageRegionSplitter::Superclass

Definition at line 39 of file otbStreamingShrinkImageFilter.h.

Constructor & Destructor Documentation

StreamingShrinkImageRegionSplitter() [1/2]

otb::StreamingShrinkImageRegionSplitter::StreamingShrinkImageRegionSplitter ( )

inlineprotected

Definition at line 89 of file otbStreamingShrinkImageFilter.h.

~StreamingShrinkImageRegionSplitter()

otb::StreamingShrinkImageRegionSplitter::~StreamingShrinkImageRegionSplitter ( )

inlineoverrideprotected

Definition at line 92 of file otbStreamingShrinkImageFilter.h.

StreamingShrinkImageRegionSplitter() [2/2]

otb::StreamingShrinkImageRegionSplitter::StreamingShrinkImageRegionSplitter ( const StreamingShrinkImageRegionSplitter &  )

privatedelete

Member Function Documentation

CreateAnother()

virtual::itk::LightObject::Pointer otb::StreamingShrinkImageRegionSplitter::CreateAnother

(

void

)

const

GetImageDimension()

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

inlinestatic

Dimension of the image available at run time.

Definition at line 53 of file otbStreamingShrinkImageFilter.h.

GetNameOfClass()

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

virtual

Run-time type information (and related methods).

GetNumberOfSplits()

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.

GetShrinkFactor()

virtual unsigned int otb::StreamingShrinkImageRegionSplitter::GetShrinkFactor ( )

virtual

GetSplit()

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.

GetTileDimension()

virtual unsigned int otb::StreamingShrinkImageRegionSplitter::GetTileDimension ( )

virtual

GetTileSizeAlignment()

virtual unsigned int otb::StreamingShrinkImageRegionSplitter::GetTileSizeAlignment ( )

virtual

New()

static Pointer otb::StreamingShrinkImageRegionSplitter::New ( )

static

Method for creation through the object factory.

operator=()

void otb::StreamingShrinkImageRegionSplitter::operator= ( const StreamingShrinkImageRegionSplitter &  )

privatedelete

PrintSelf()

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

overrideprotected

SetShrinkFactor()

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

virtual

Member Data Documentation

ImageDimension

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

static

Dimension of the image available at compile time.

Definition at line 50 of file otbStreamingShrinkImageFilter.h.

m_ShrinkFactor

unsigned int otb::StreamingShrinkImageRegionSplitter::m_ShrinkFactor

private

Definition at line 104 of file otbStreamingShrinkImageFilter.h.

m_SplitsPerDimension

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

private

Definition at line 101 of file otbStreamingShrinkImageFilter.h.

m_TileDimension

unsigned int otb::StreamingShrinkImageRegionSplitter::m_TileDimension

private

Definition at line 102 of file otbStreamingShrinkImageFilter.h.

m_TileSizeAlignment

unsigned int otb::StreamingShrinkImageRegionSplitter::m_TileSizeAlignment

private

Definition at line 103 of file otbStreamingShrinkImageFilter.h.

---

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

• otbStreamingShrinkImageFilter.h