#include <itkImageRegionMultidimensionalSplitter.h>

Inheritance diagram for itk::ImageRegionMultidimensionalSplitter< VImageDimension >:

Collaboration diagram for itk::ImageRegionMultidimensionalSplitter< VImageDimension >:

Detailed Description

template<unsigned int VImageDimension>
class itk::ImageRegionMultidimensionalSplitter< VImageDimension >

Divide a region into several pieces.

ImageRegionMultidimensionalSplitter divides an ImageRegion into smaller regions. ImageRegionMultidimensionalSplitter 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 less then or equal to the argumen 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).

ImageRegionMultidimensionalSplitter class divides a region into hypercubes (as opposed to the slabs used by the superclass ImageRegionSplitter). In other words, it splits every dimension of the region to form ND rectangular prisms.

Deprecated:: The new class ImageRegionSplitterMultidimensional can be used as a drop in replacement for the same functionality as it implements the same algorithm.

Definition at line 61 of file itkImageRegionMultidimensionalSplitter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Index< VImageDimension >	IndexType

typedef SmartPointer< Self >	Pointer

typedef ImageRegion < VImageDimension >	RegionType

typedef ImageRegionMultidimensionalSplitter	Self

typedef Size< VImageDimension >	SizeType

typedef ImageRegionSplitter < VImageDimension >	Superclass

Public Types inherited from itk::ImageRegionSplitter< VImageDimension >
typedef SmartPointer< const Self >	ConstPointer

typedef Index< VImageDimension >	IndexType

typedef SmartPointer< Self >	Pointer

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 Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef ImageRegionSplitterBase	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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

virtual const char *	GetNameOfClass () 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::ImageRegionSplitter< VImageDimension >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

Public Member Functions inherited from itk::ImageRegionSplitterBase
template<unsigned int VImageDimension>
unsigned int	GetSplit (unsigned int i, unsigned int numberOfPieces, ImageRegion< VImageDimension > &region) const

unsigned int	GetSplit (unsigned int i, unsigned int numberOfPieces, ImageIORegion &region) const

template<unsigned int VImageDimension>
unsigned int	GetNumberOfSplits (const ImageRegion< VImageDimension > &region, unsigned int requestedNumber) const

unsigned int	GetNumberOfSplits (const ImageIORegion &region, unsigned int requestedNumber) 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

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 = VImageDimension

Protected Member Functions
	ImageRegionMultidimensionalSplitter ()

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

	~ImageRegionMultidimensionalSplitter ()

Protected Member Functions inherited from itk::ImageRegionSplitter< VImageDimension >
virtual unsigned int	GetNumberOfSplitsInternal (unsigned int, const IndexValueType regionIndex[], const SizeValueType regionSize[], unsigned int requestedNumber) const ITK_OVERRIDE

virtual unsigned int	GetSplitInternal (unsigned int dim, unsigned int i, unsigned int numberOfPieces, IndexValueType regionIndex[], SizeValueType regionSize[]) const ITK_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
	ImageRegionMultidimensionalSplitter (const Self &)

void	operator= (const Self &)

Static Private Member Functions
static unsigned int	ComputeSplits (unsigned int numberOfPieces, const RegionType &region, unsigned int splits[])

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock