 |
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageRegionSplitterBase.h>
Inheritance diagram for itk::ImageRegionSplitterBase: Collaboration diagram for itk::ImageRegionSplitterBase: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).
Definition at line 58 of file itkImageRegionSplitterBase.h.
Public Types | |
| 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 const char * | GetNameOfClass () const |
| template<unsigned int VImageDimension> | |
| unsigned int | GetSplit (unsigned int i, unsigned int numberOfPieces, ImageRegion< VImageDimension > ®ion) const |
| unsigned int | GetSplit (unsigned int i, unsigned int numberOfPieces, ImageIORegion ®ion) const |
| template<unsigned int VImageDimension> | |
| unsigned int | GetNumberOfSplits (const ImageRegion< VImageDimension > ®ion, unsigned int requestedNumber) const |
| unsigned int | GetNumberOfSplits (const ImageIORegion ®ion, 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 LightObject::Pointer | CreateAnother () const override |
| 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 |
Protected Member Functions | |
| 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 |
| ImageRegionSplitterBase () | |
| virtual void | PrintSelf (std::ostream &os, Indent indent) const override |
| Protected Member Functions inherited from itk::Object | |
| Object () | |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| virtual void | SetTimeStamp (const TimeStamp &time) |
| virtual | ~Object () override |
| 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 () |
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 Attributes inherited from itk::LightObject | |
| AtomicInt< int > | m_ReferenceCount |
| typedef SmartPointer< const Self > itk::ImageRegionSplitterBase::ConstPointer |
Definition at line 66 of file itkImageRegionSplitterBase.h.
Definition at line 65 of file itkImageRegionSplitterBase.h.
Standard class typedefs.
Definition at line 63 of file itkImageRegionSplitterBase.h.
Definition at line 64 of file itkImageRegionSplitterBase.h.
|
protected |
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::Object.
Reimplemented in itk::ImageRegionSplitter< VImageDimension >, itk::ImageRegionMultidimensionalSplitter< VImageDimension >, itk::ImageRegionSplitterMultidimensional, itk::ImageRegionSplitterSlowDimension, and itk::ImageRegionSplitterDirection.
|
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 78 of file itkImageRegionSplitterBase.h.
References itk::ImageRegion< VImageDimension >::GetIndex(), and itk::ImageRegion< VImageDimension >::GetSize().
Referenced by itk::ImageRegionSplitter< VImageDimension >::GetNumberOfSplitsInternal().
|
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().
|
protectedpure virtual |
Templetless method to compute the number of possible splits for any number of dimensions.
Implemented in itk::ImageRegionSplitter< VImageDimension >, itk::ImageRegionSplitterMultidimensional, itk::ImageRegionSplitterSlowDimension, and itk::ImageRegionSplitterDirection.
|
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 106 of file itkImageRegionSplitterBase.h.
References itk::ImageRegion< VImageDimension >::GetModifiableIndex(), and itk::ImageRegion< VImageDimension >::GetModifiableSize().
Referenced by itk::ImageRegionSplitter< VImageDimension >::GetSplitInternal().
|
inline |
Definition at line 116 of file itkImageRegionSplitterBase.h.
References itk::ImageIORegion::GetImageDimension(), itk::ImageIORegion::GetModifiableIndex(), and itk::ImageIORegion::GetModifiableSize().
|
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::ImageRegionSplitter< VImageDimension >, itk::ImageRegionSplitterMultidimensional, itk::ImageRegionSplitterSlowDimension, and itk::ImageRegionSplitterDirection.
|
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::Object.
Reimplemented in itk::ImageRegionSplitter< VImageDimension >, itk::ImageRegionMultidimensionalSplitter< VImageDimension >, itk::ImageRegionSplitterMultidimensional, and itk::ImageRegionSplitterDirection.
1.8.5
