#include <itkImageRegionSplitterMultidimensional.h>

Inheritance diagram for itk::ImageRegionSplitterMultidimensional:

Collaboration diagram for itk::ImageRegionSplitterMultidimensional:

Detailed Description

Divide a region into several pieces.

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

ImageRegionSplitterMultidimensional 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.

Definition at line 58 of file itkImageRegionSplitterMultidimensional.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef ImageRegionSplitterMultidimensional	Self

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 () const

virtual const char *	GetNameOfClass () 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 ()

const MetaDataDictionary &	GetMetaDataDictionary () 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 override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

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::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 ()

Protected Member Functions
virtual unsigned int	GetNumberOfSplitsInternal (unsigned int dim, 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

	ImageRegionSplitterMultidimensional ()

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

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
	ImageRegionSplitterMultidimensional (const Self &)

void	operator= (const Self &)

Static Private Member Functions
static unsigned int	ComputeSplits (unsigned int dim, unsigned int requestedNumber, const IndexValueType regionIndex[], const SizeValueType regionSize[], unsigned int splits[])

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer< const Self > itk::ImageRegionSplitterMultidimensional::ConstPointer

Definition at line 66 of file itkImageRegionSplitterMultidimensional.h.

typedef SmartPointer< Self > itk::ImageRegionSplitterMultidimensional::Pointer

Definition at line 65 of file itkImageRegionSplitterMultidimensional.h.

typedef ImageRegionSplitterMultidimensional itk::ImageRegionSplitterMultidimensional::Self

Standard class typedefs.

Definition at line 63 of file itkImageRegionSplitterMultidimensional.h.

typedef ImageRegionSplitterBase itk::ImageRegionSplitterMultidimensional::Superclass

Definition at line 64 of file itkImageRegionSplitterMultidimensional.h.

Constructor & Destructor Documentation

itk::ImageRegionSplitterMultidimensional::ImageRegionSplitterMultidimensional ( )

protected

itk::ImageRegionSplitterMultidimensional::ImageRegionSplitterMultidimensional ( const Self & )

private

Member Function Documentation

static unsigned int itk::ImageRegionSplitterMultidimensional::ComputeSplits	(	unsigned int	dim,
		unsigned int	requestedNumber,
		const IndexValueType	regionIndex[],
		const SizeValueType	regionSize[],
		unsigned int	splits[]
	)

staticprivate

virtual::itk::LightObject::Pointer itk::ImageRegionSplitterMultidimensional::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

virtual const char* itk::ImageRegionSplitterMultidimensional::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageRegionSplitterBase.

virtual unsigned int itk::ImageRegionSplitterMultidimensional::GetNumberOfSplitsInternal	(	unsigned int	dim,
		const IndexValueType	regionIndex[],
		const SizeValueType	regionSize[],
		unsigned int	requestedNumber
	)		const

overrideprotectedvirtual

Templetless method to compute the number of possible splits for any number of dimensions.

Implements itk::ImageRegionSplitterBase.

virtual unsigned int itk::ImageRegionSplitterMultidimensional::GetSplitInternal	(	unsigned int	dim,
		unsigned int	i,
		unsigned int	numberOfPieces,
		IndexValueType	regionIndex[],
		SizeValueType	regionSize[]
	)		const

overrideprotectedvirtual

Templetless method to compute an actual split for any number of dimensions. dim is the size of the regionIndex and regionSize arrays.

Implements itk::ImageRegionSplitterBase.

static Pointer itk::ImageRegionSplitterMultidimensional::New ( )

static

Method for creation through the object factory.

void itk::ImageRegionSplitterMultidimensional::operator= ( const Self & )

private

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

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageRegionSplitterBase.

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

itkImageRegionSplitterMultidimensional.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation