ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Private Member Functions | List of all members
itk::ImageRegionSplitterMultidimensional Class Reference

#include <itkImageRegionSplitterMultidimensional.h>

+ Inheritance diagram for itk::ImageRegionSplitterMultidimensional:
+ Collaboration diagram for itk::ImageRegionSplitterMultidimensional:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageRegionSplitterMultidimensional
 
using Superclass = ImageRegionSplitterBase
 
- Public Types inherited from itk::ImageRegionSplitterBase
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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ImageRegionSplitterBase
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
 
- 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
 

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

unsigned int GetNumberOfSplitsInternal (unsigned int dim, const IndexValueType regionIndex[], const SizeValueType regionSize[], unsigned int requestedNumber) const override
 
unsigned int GetSplitInternal (unsigned int dim, unsigned int i, unsigned int numberOfPieces, IndexValueType regionIndex[], SizeValueType regionSize[]) const override
 
 ImageRegionSplitterMultidimensional ()
 
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 ()
 
 ~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 ()
 

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
std::atomic< int > m_ReferenceCount
 

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

Member Typedef Documentation

◆ ConstPointer

Definition at line 67 of file itkImageRegionSplitterMultidimensional.h.

◆ Pointer

Definition at line 66 of file itkImageRegionSplitterMultidimensional.h.

◆ Self

Standard class type aliases.

Definition at line 64 of file itkImageRegionSplitterMultidimensional.h.

◆ Superclass

Definition at line 65 of file itkImageRegionSplitterMultidimensional.h.

Constructor & Destructor Documentation

◆ ImageRegionSplitterMultidimensional()

itk::ImageRegionSplitterMultidimensional::ImageRegionSplitterMultidimensional ( )
protected

Member Function Documentation

◆ ComputeSplits()

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

◆ CreateAnother()

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::LightObject.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::ImageRegionSplitterBase.

◆ GetNumberOfSplitsInternal()

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.

◆ GetSplitInternal()

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.

◆ New()

static Pointer itk::ImageRegionSplitterMultidimensional::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

void itk::ImageRegionSplitterMultidimensional::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::ImageRegionSplitterBase.


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