 |
ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageRegionConstIterator.h>
Inheritance diagram for itk::ImageRegionConstIterator< TImage >: Collaboration diagram for itk::ImageRegionConstIterator< TImage >:A multi-dimensional iterator templated over image type that walks a region of pixels.
The itk::ImageRegionConstIterator is optimized for iteration speed and is the first choice for iterative, pixel-wise operations on an image. ImageRegionIterator is the least specialized of the ITK image iterator classes. ImageRegionConstIterator is templated over the image type, and is constrained to walk only within the specified region and along a line parallel to one of the coordinate axes, "wrapping" to the next line as it reaches the boundary of the image. To walk the entire image, specify the region to be image->GetRequestedRegion().
ImageRegionConstIterator provides read-only access to image data. It is the base class for the read/write access ImageRegionIterator.
ImageRegionConstIterator is a multi-dimensional iterator, requiring more information be specified before the iterator can be used than conventional iterators. Whereas the std::vector::iterator from the STL only needs to be passed a pointer to establish the iterator, the multi-dimensional image iterator needs a pointer, the size of the buffer, the size of the region, the start index of the buffer, and the start index of the region. To gain access to this information, ImageRegionConstIterator holds a reference to the image over which it is traversing.
ImageRegionConstIterator assumes a particular layout of the image data. The is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.
operator++ provides a simple syntax for walking around a region of a multidimensional image. operator++ iterates across a row, constraining the movement to within a region of image. When the iterator reaches the boundary of the region along a row, the iterator automatically wraps to the next row, starting at the first pixel in the row that is part of the region. This allows for simple processing loops of the form:
Definition at line 107 of file itkImageRegionConstIterator.h.
Public Member Functions | |
| virtual const char * | GetNameOfClass () const |
| void | GoToBegin () |
| void | GoToEnd () |
| ImageRegionConstIterator () | |
| ImageRegionConstIterator (const ImageIterator< TImage > &it) | |
| ImageRegionConstIterator (const ImageConstIterator< TImage > &it) | |
| itkLegacyMacro (Self Begin(void) const) | |
| itkLegacyMacro (Self End(void) const) | |
| ImageRegionConstIterator (const ImageType *ptr, const RegionType ®ion) | |
| void | SetIndex (const IndexType &ind) |
| Self & | operator++ () |
| Self & | operator-- () |
| Public Member Functions inherited from itk::ImageConstIterator< TImage > | |
| ImageConstIterator (const Self &it) | |
| virtual | ~ImageConstIterator () |
| ImageConstIterator () | |
| ImageConstIterator (const ImageType *ptr, const RegionType ®ion) | |
| Self & | operator= (const Self &it) |
| virtual void | SetRegion (const RegionType ®ion) |
| bool | operator!= (const Self &it) const |
| bool | operator== (const Self &it) const |
| bool | operator<= (const Self &it) const |
| bool | operator< (const Self &it) const |
| bool | operator>= (const Self &it) const |
| bool | operator> (const Self &it) const |
| const IndexType | GetIndex () const |
| const RegionType & | GetRegion () const |
| const ImageType * | GetImage () const |
| PixelType | Get (void) const |
| const PixelType & | Value (void) const |
| itkLegacyMacro (Self Begin(void) const) | |
| void | GoToBegin () |
| itkLegacyMacro (Self End(void) const) | |
| void | GoToEnd () |
| bool | IsAtBegin (void) const |
| bool | IsAtEnd (void) const |
Static Public Attributes | |
| static const unsigned int | ImageIteratorDimension = Superclass::ImageIteratorDimension |
| Static Public Attributes inherited from itk::ImageConstIterator< TImage > | |
| static const unsigned int | ImageIteratorDimension = TImage::ImageDimension |
Protected Attributes | |
| OffsetValueType | m_SpanBeginOffset |
| OffsetValueType | m_SpanEndOffset |
| Protected Attributes inherited from itk::ImageConstIterator< TImage > | |
| TImage::ConstWeakPointer | m_Image |
| RegionType | m_Region |
| OffsetValueType | m_Offset |
| OffsetValueType | m_BeginOffset |
| OffsetValueType | m_EndOffset |
| const InternalPixelType * | m_Buffer |
| AccessorType | m_PixelAccessor |
| AccessorFunctorType | m_PixelAccessorFunctor |
Private Member Functions | |
| void | Decrement () |
| void | Increment () |
| typedef Superclass::AccessorType itk::ImageRegionConstIterator< TImage >::AccessorType |
Definition at line 136 of file itkImageRegionConstIterator.h.
| typedef Superclass::ImageType itk::ImageRegionConstIterator< TImage >::ImageType |
Definition at line 131 of file itkImageRegionConstIterator.h.
| typedef Superclass::IndexType itk::ImageRegionConstIterator< TImage >::IndexType |
Index typedef support. While these were already typdef'ed in the superclass, they need to be redone here for this subclass to compile properly with gcc.Types inherited from the Superclass
Definition at line 127 of file itkImageRegionConstIterator.h.
| typedef Superclass::InternalPixelType itk::ImageRegionConstIterator< TImage >::InternalPixelType |
Definition at line 134 of file itkImageRegionConstIterator.h.
| typedef Superclass::OffsetType itk::ImageRegionConstIterator< TImage >::OffsetType |
Definition at line 129 of file itkImageRegionConstIterator.h.
| typedef Superclass::PixelContainer itk::ImageRegionConstIterator< TImage >::PixelContainer |
Definition at line 132 of file itkImageRegionConstIterator.h.
| typedef Superclass::PixelContainerPointer itk::ImageRegionConstIterator< TImage >::PixelContainerPointer |
Definition at line 133 of file itkImageRegionConstIterator.h.
| typedef Superclass::PixelType itk::ImageRegionConstIterator< TImage >::PixelType |
Definition at line 135 of file itkImageRegionConstIterator.h.
| typedef Superclass::RegionType itk::ImageRegionConstIterator< TImage >::RegionType |
Definition at line 130 of file itkImageRegionConstIterator.h.
| typedef ImageRegionConstIterator itk::ImageRegionConstIterator< TImage >::Self |
Standard class typedef.
Definition at line 111 of file itkImageRegionConstIterator.h.
| typedef Superclass::SizeType itk::ImageRegionConstIterator< TImage >::SizeType |
Definition at line 128 of file itkImageRegionConstIterator.h.
| typedef ImageConstIterator< TImage > itk::ImageRegionConstIterator< TImage >::Superclass |
Definition at line 112 of file itkImageRegionConstIterator.h.
|
inline |
Default constructor. Needed since we provide a cast constructor.
Definition at line 142 of file itkImageRegionConstIterator.h.
|
inline |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
Definition at line 150 of file itkImageRegionConstIterator.h.
|
inline |
Constructor that can be used to cast from an ImageIterator to an ImageRegionConstIterator. Many routines return an ImageIterator, but for a particular task, you may want an ImageRegionConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionConstIterator.
Definition at line 165 of file itkImageRegionConstIterator.h.
|
inline |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionConstIterator. Many routines return an ImageIterator, but for a particular task, you may want an ImageRegionConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionConstIterator.
Definition at line 182 of file itkImageRegionConstIterator.h.
|
private |
Referenced by itk::ImageRegionConstIterator< ImageType >::operator--().
|
virtual |
Run-time type information (and related methods).
|
inline |
Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.
Definition at line 195 of file itkImageRegionConstIterator.h.
Referenced by itk::Statistics::ImageToListSampleAdaptor< TImage >::Begin(), and itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >::SetLevelSet().
|
inline |
Move an iterator to the end of the region. "End" is defined as one pixel past the last pixel of the region.
Definition at line 206 of file itkImageRegionConstIterator.h.
Referenced by itk::Statistics::ImageToListSampleAdaptor< TImage >::End().
|
private |
Referenced by itk::ImageRegionConstIterator< ImageType >::operator++().
| itk::ImageRegionConstIterator< TImage >::itkLegacyMacro | ( | Self Begin(void) | const | ) |
Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.
| itk::ImageRegionConstIterator< TImage >::itkLegacyMacro | ( | Self End(void) | const | ) |
Return an iterator for the end of the region. "End" is defined as one pixel past the last pixel of the region.
|
inline |
Increment (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the end of the row of the region to the beginning of the next row of the region) up until the iterator tries to moves past the last pixel of the region. Here, the iterator will be set to be one pixel past the end of the region.
Definition at line 245 of file itkImageRegionConstIterator.h.
|
inline |
Decrement (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the beginning of the row of the region to the end of the next row of the region) up until the iterator tries to moves past the first pixel of the region. Here, the iterator will be set to be one pixel past the beginning of the region.
Definition at line 262 of file itkImageRegionConstIterator.h.
|
inlinevirtual |
Set the index. No bounds checking is performed. This is overridden from the parent because we have an extra ivar.
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 228 of file itkImageRegionConstIterator.h.
Referenced by itk::BoxMeanCalculatorFunction(), and itk::BoxSigmaCalculatorFunction().
|
static |
Dimension of the image that the iterator walks. This constant is needed so functions that are templated over image iterator type (as opposed to being templated over pixel type and dimension) can have compile time access to the dimension of the image that the iterator walks.
Definition at line 119 of file itkImageRegionConstIterator.h.
|
protected |
Definition at line 273 of file itkImageRegionConstIterator.h.
Referenced by itk::ImageRegionConstIterator< ImageType >::GoToBegin(), itk::ImageRegionConstIterator< ImageType >::GoToEnd(), itk::ImageRegionConstIterator< ImageType >::ImageRegionConstIterator(), itk::ImageRegionConstIterator< ImageType >::operator--(), and itk::ImageRegionConstIterator< ImageType >::SetIndex().
|
protected |
Definition at line 275 of file itkImageRegionConstIterator.h.
Referenced by itk::ImageRegionConstIterator< ImageType >::GoToBegin(), itk::ImageRegionConstIterator< ImageType >::GoToEnd(), itk::ImageRegionConstIterator< ImageType >::ImageRegionConstIterator(), itk::ImageRegionConstIterator< ImageType >::operator++(), and itk::ImageRegionConstIterator< ImageType >::SetIndex().
1.8.5
