ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
itk::ImageRegionSplitter< VImageDimension > Class Template Reference

#include <itkImageRegionSplitter.h>

+ Inheritance diagram for itk::ImageRegionSplitter< VImageDimension >:
+ Collaboration diagram for itk::ImageRegionSplitter< VImageDimension >:

Detailed Description

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

Divide a region into several pieces.

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

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

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

Deprecated:
The new class ImageRegionSplitterSlowDimension can be used as a drop in replacement for functionality as it implements the same algorithm. The ImageRegionSplitterBase is now the abstract base class for all image splitter. New splitting object should be derived from that class.
See Also
ImageRegionSplitterSlowDimension
ImageRegionSplitterBase

Definition at line 68 of file itkImageRegionSplitter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Index< VImageDimension > IndexType
 
typedef SmartPointer< SelfPointer
 
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 SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef ImageRegionSplitterBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () 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::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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 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
 

Protected Member Functions

virtual unsigned int GetNumberOfSplitsInternal (unsigned int, 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
 
 ImageRegionSplitter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~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

 ImageRegionSplitter (const ImageRegionSplitter &)
 
void operator= (const ImageRegionSplitter &)
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 75 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
typedef Index< VImageDimension > itk::ImageRegionSplitter< VImageDimension >::IndexType

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

Definition at line 91 of file itkImageRegionSplitter.h.

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

Definition at line 74 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
typedef ImageRegion< VImageDimension > itk::ImageRegionSplitter< VImageDimension >::RegionType

Region typedef support.

Definition at line 98 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
typedef ImageRegionSplitter itk::ImageRegionSplitter< VImageDimension >::Self

Standard class typedefs.

Definition at line 72 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
typedef Size< VImageDimension > itk::ImageRegionSplitter< VImageDimension >::SizeType

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

Definition at line 94 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
typedef SizeType::SizeValueType itk::ImageRegionSplitter< VImageDimension >::SizeValueType

Definition at line 95 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
typedef ImageRegionSplitterBase itk::ImageRegionSplitter< VImageDimension >::Superclass

Definition at line 73 of file itkImageRegionSplitter.h.

Constructor & Destructor Documentation

template<unsigned int VImageDimension>
itk::ImageRegionSplitter< VImageDimension >::ImageRegionSplitter ( )
inlineprotected

Definition at line 117 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
itk::ImageRegionSplitter< VImageDimension >::~ImageRegionSplitter ( )
inlineprotected

Definition at line 118 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
itk::ImageRegionSplitter< VImageDimension >::ImageRegionSplitter ( const ImageRegionSplitter< VImageDimension > &  )
private

Member Function Documentation

template<unsigned int VImageDimension>
virtual::itk::LightObject::Pointer itk::ImageRegionSplitter< VImageDimension >::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.

template<unsigned int VImageDimension>
static unsigned int itk::ImageRegionSplitter< VImageDimension >::GetImageDimension ( )
inlinestatic

Dimension of the image available at run time.

Definition at line 87 of file itkImageRegionSplitter.h.

template<unsigned int VImageDimension>
virtual const char* itk::ImageRegionSplitter< VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageRegionSplitterBase.

Reimplemented in itk::ImageRegionMultidimensionalSplitter< VImageDimension >.

template<unsigned int VImageDimension>
virtual unsigned int itk::ImageRegionSplitter< VImageDimension >::GetNumberOfSplits ( const RegionType region,
unsigned int  requestedNumber 
)
virtual

How many pieces can the specifed 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.

Reimplemented in itk::ImageRegionMultidimensionalSplitter< VImageDimension >.

template<unsigned int VImageDimension>
virtual unsigned int itk::ImageRegionSplitter< VImageDimension >::GetNumberOfSplitsInternal ( unsigned  dim,
const IndexValueType  regionIndex[],
const SizeValueType  regionSize[],
unsigned int  requestedNumber 
) const
inlineoverrideprotectedvirtual

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

Implements itk::ImageRegionSplitterBase.

Definition at line 120 of file itkImageRegionSplitter.h.

References itk::ImageRegionSplitterBase::GetNumberOfSplits(), itk::Index< VIndexDimension >::SetIndex(), and itk::Size< VDimension >::SetSize().

template<unsigned int VImageDimension>
virtual RegionType itk::ImageRegionSplitter< VImageDimension >::GetSplit ( unsigned int  i,
unsigned int  numberOfPieces,
const RegionType region 
)
virtual

Get a region definition that represents the ith piece a specified region. The "numberOfPieces" must be equal to what GetNumberOfSplits() returns.

Reimplemented in itk::ImageRegionMultidimensionalSplitter< VImageDimension >.

template<unsigned int VImageDimension>
virtual unsigned int itk::ImageRegionSplitter< VImageDimension >::GetSplitInternal ( unsigned int  dim,
unsigned int  i,
unsigned int  numberOfPieces,
IndexValueType  regionIndex[],
SizeValueType  regionSize[] 
) const
inlineoverrideprotectedvirtual

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.

Definition at line 138 of file itkImageRegionSplitter.h.

References itk::ImageRegion< VImageDimension >::GetIndex(), itk::ImageRegion< VImageDimension >::GetSize(), itk::ImageRegionSplitterBase::GetSplit(), itk::Index< VIndexDimension >::SetIndex(), and itk::Size< VDimension >::SetSize().

template<unsigned int VImageDimension>
static Pointer itk::ImageRegionSplitter< VImageDimension >::New ( )
static

Method for creation through the object factory.

template<unsigned int VImageDimension>
void itk::ImageRegionSplitter< VImageDimension >::operator= ( const ImageRegionSplitter< VImageDimension > &  )
private
template<unsigned int VImageDimension>
virtual void itk::ImageRegionSplitter< VImageDimension >::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.

Reimplemented in itk::ImageRegionMultidimensionalSplitter< VImageDimension >.

Member Data Documentation

template<unsigned int VImageDimension>
const unsigned int itk::ImageRegionSplitter< VImageDimension >::ImageDimension = VImageDimension
static

Dimension of the image available at compile time.

Definition at line 84 of file itkImageRegionSplitter.h.


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