ITK  5.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | List of all members
itk::ImageRegionSplitterBase Class Referenceabstract

#include <itkImageRegionSplitterBase.h>

+ Inheritance diagram for itk::ImageRegionSplitterBase:
+ Collaboration diagram for itk::ImageRegionSplitterBase:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageRegionSplitterBase
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
LightObject::Pointer CreateAnother () const override
 
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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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
 
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
 
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
 
 ImageRegionSplitterBase ()
 
virtual unsigned int GetNumberOfSplitsInternal (unsigned int dim, const IndexValueType regionIndex[], const SizeValueType regionSize[], unsigned int requestedNumber) const =0
 
virtual unsigned int GetSplitInternal (unsigned int dim, unsigned int i, unsigned int numberOfPieces, IndexValueType regionIndex[], SizeValueType regionSize[]) const =0
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- 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 inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

Divide an image region into several pieces.

ImageRegionSplitterBase is an abstract interface to divide an ImageRegion into smaller regions. ImageRegionSplitterBase is used by the ImageSource, StreamingImageFilter, streaming ImageIO classes to divide a region into a series of smaller subregions.

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

See also
ImageRegionSplitterDirection
ImageRegionSplitterSlowDimension

Definition at line 58 of file itkImageRegionSplitterBase.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 67 of file itkImageRegionSplitterBase.h.

◆ Pointer

Definition at line 66 of file itkImageRegionSplitterBase.h.

◆ Self

Standard class type aliases.

Definition at line 64 of file itkImageRegionSplitterBase.h.

◆ Superclass

Definition at line 65 of file itkImageRegionSplitterBase.h.

Constructor & Destructor Documentation

◆ ImageRegionSplitterBase()

itk::ImageRegionSplitterBase::ImageRegionSplitterBase ( )
protected

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.

Member Function Documentation

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

Reimplemented in itk::ImageRegionSplitterMultidimensional, itk::ImageRegionSplitterSlowDimension, and itk::ImageRegionSplitterDirection.

◆ GetNumberOfSplits() [1/2]

unsigned int itk::ImageRegionSplitterBase::GetNumberOfSplits ( const ImageIORegion region,
unsigned int  requestedNumber 
) const
inline

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 86 of file itkImageRegionSplitterBase.h.

References itk::ImageIORegion::GetImageDimension(), itk::ImageIORegion::GetIndex(), and itk::ImageIORegion::GetSize().

◆ GetNumberOfSplits() [2/2]

template<unsigned int VImageDimension>
unsigned int itk::ImageRegionSplitterBase::GetNumberOfSplits ( const ImageRegion< VImageDimension > &  region,
unsigned int  requestedNumber 
) const
inline

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 80 of file itkImageRegionSplitterBase.h.

References itk::ImageRegion< VImageDimension >::GetIndex(), and itk::ImageRegion< VImageDimension >::GetSize().

◆ GetNumberOfSplitsInternal()

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

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

Implemented in itk::ImageRegionSplitterMultidimensional, itk::ImageRegionSplitterSlowDimension, and itk::ImageRegionSplitterDirection.

◆ GetSplit() [1/2]

unsigned int itk::ImageRegionSplitterBase::GetSplit ( unsigned int  i,
unsigned int  numberOfPieces,
ImageIORegion region 
) const
inline

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 113 of file itkImageRegionSplitterBase.h.

References itk::ImageIORegion::GetImageDimension(), itk::ImageIORegion::GetModifiableIndex(), and itk::ImageIORegion::GetModifiableSize().

◆ GetSplit() [2/2]

template<unsigned int VImageDimension>
unsigned int itk::ImageRegionSplitterBase::GetSplit ( unsigned int  i,
unsigned int  numberOfPieces,
ImageRegion< VImageDimension > &  region 
) const
inline

Get a region definition that represents the ith piece a specified region.

The numberOfPieces must be equal to what GetNumberOfSplits() returns. The return value is the maximum number of splits available. If i is greater than or equal to the return value the value of the region is undefined.

Definition at line 104 of file itkImageRegionSplitterBase.h.

References itk::ImageRegion< VImageDimension >::GetModifiableIndex(), and itk::ImageRegion< VImageDimension >::GetModifiableSize().

◆ GetSplitInternal()

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

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

Implemented in itk::ImageRegionSplitterMultidimensional, itk::ImageRegionSplitterSlowDimension, and itk::ImageRegionSplitterDirection.

◆ PrintSelf()

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

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.

Reimplemented from itk::LightObject.

Reimplemented in itk::ImageRegionSplitterMultidimensional, and itk::ImageRegionSplitterDirection.


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