 |
ITK
6.0.0
Insight Toolkit
|
|
ITK
6.0.0
Insight Toolkit
|
#include <itkImageRegionConstIteratorWithIndex.h>
A multi-dimensional iterator templated over image type that walks an image region and is specialized to keep track of its index location.
The "WithIndex" family of iterators was designed for algorithms that use both the values and locations of image pixels in calculations. Unlike ImageRegionIterator, which calculates an index only when requested, ImageRegionIteratorWithIndex maintains its index location as a member variable that is updated during increment and decrement operations. Iteration speed is penalized, but index queries become more efficient.
ImageRegionConstIteratorWithIndex 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, ImageRegionConstIteratorWithIndex holds a reference to the image over which it is traversing.
ImageRegionConstIteratorWithIndex 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:
It also can be used for walking in the reverse direction like
For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from https://www.itk.org.
Definition at line 129 of file itkImageRegionConstIteratorWithIndex.h.
Inheritance diagram for itk::ImageRegionConstIteratorWithIndex< TImage >: Collaboration diagram for itk::ImageRegionConstIteratorWithIndex< TImage >:Public Types | |
| using | AccessorType = typename TImage::AccessorType |
| using | ImageType = TImage |
| using | IndexType = typename TImage::IndexType |
| using | InternalPixelType = typename TImage::InternalPixelType |
| using | OffsetType = typename TImage::OffsetType |
| using | PixelContainer = typename TImage::PixelContainer |
| using | PixelContainerPointer = typename PixelContainer::Pointer |
| using | PixelType = typename TImage::PixelType |
| using | RegionType = typename TImage::RegionType |
| using | Self = ImageRegionConstIteratorWithIndex |
| using | SizeType = typename TImage::SizeType |
| using | Superclass = ImageConstIteratorWithIndex< TImage > |
| Public Types inherited from itk::ImageConstIteratorWithIndex< TImage > | |
| using | AccessorFunctorType = typename TImage::AccessorFunctorType |
| using | AccessorType = typename TImage::AccessorType |
| using | ImageType = TImage |
| using | IndexType = typename TImage::IndexType |
| using | IndexValueType = typename IndexType::IndexValueType |
| using | InternalPixelType = typename TImage::InternalPixelType |
| using | OffsetType = typename TImage::OffsetType |
| using | OffsetValueType = typename OffsetType::OffsetValueType |
| using | PixelContainer = typename TImage::PixelContainer |
| using | PixelContainerPointer = typename PixelContainer::Pointer |
| using | PixelType = typename TImage::PixelType |
| using | RegionType = typename TImage::RegionType |
| using | Self = ImageConstIteratorWithIndex |
| using | SizeType = typename TImage::SizeType |
| using | SizeValueType = typename SizeType::SizeValueType |
Additional Inherited Members | |
| Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage > | |
| static constexpr unsigned int | GetImageDimension () |
| Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage > | |
| static constexpr unsigned int | ImageDimension = TImage::ImageDimension |
| Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage > | |
| const InternalPixelType * | m_Begin { nullptr } |
| IndexType | m_BeginIndex { { 0 } } |
| const InternalPixelType * | m_End { nullptr } |
| IndexType | m_EndIndex { { 0 } } |
| TImage::ConstWeakPointer | m_Image {} |
| OffsetValueType | m_OffsetTable [ImageDimension+1] {} |
| AccessorType | m_PixelAccessor {} |
| AccessorFunctorType | m_PixelAccessorFunctor {} |
| const InternalPixelType * | m_Position { nullptr } |
| IndexType | m_PositionIndex { { 0 } } |
| RegionType | m_Region {} |
| bool | m_Remaining { false } |
| using itk::ImageConstIteratorWithIndex< TImage >::AccessorType = typename TImage::AccessorType |
Accessor type that converts data between internal and external representations.
Definition at line 132 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::ImageType = TImage |
Image type alias support
Definition at line 116 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::IndexType = typename TImage::IndexType |
Index type alias support
Definition at line 105 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType = typename TImage::InternalPixelType |
Internal Pixel Type
Definition at line 125 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::OffsetType = typename TImage::OffsetType |
Type of the Offset taken from the image
Definition at line 136 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::PixelContainer = typename TImage::PixelContainer |
PixelContainer type alias support Used to refer to the container for the pixel data. While this was already typedef'ed in the superclass, it needs to be redone here for this subclass to compile properly with gcc.
Definition at line 121 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::PixelContainerPointer = typename PixelContainer::Pointer |
Definition at line 122 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::PixelType = typename TImage::PixelType |
External Pixel Type
Definition at line 128 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::RegionType = typename TImage::RegionType |
Region type alias support
Definition at line 113 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageRegionConstIteratorWithIndex< TImage >::Self = ImageRegionConstIteratorWithIndex |
Standard class type aliases.
Definition at line 133 of file itkImageRegionConstIteratorWithIndex.h.
| using itk::ImageConstIteratorWithIndex< TImage >::SizeType = typename TImage::SizeType |
Size type alias support
Definition at line 109 of file itkImageConstIteratorWithIndex.h.
| using itk::ImageRegionConstIteratorWithIndex< TImage >::Superclass = ImageConstIteratorWithIndex<TImage> |
Definition at line 134 of file itkImageRegionConstIteratorWithIndex.h.
|
inline |
Default constructor. Needed since we provide a cast constructor.
Definition at line 154 of file itkImageRegionConstIteratorWithIndex.h.
|
inline |
Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes the iterator at the begin of the region.
Definition at line 160 of file itkImageRegionConstIteratorWithIndex.h.
|
inline |
Constructor that can be used to cast from an ImageIterator to an ImageRegionConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageRegionConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageRegionConstIteratorWithIndex.
Definition at line 170 of file itkImageRegionConstIteratorWithIndex.h.
| Self & itk::ImageRegionConstIteratorWithIndex< TImage >::operator++ | ( | ) |
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.
| Self & itk::ImageRegionConstIteratorWithIndex< TImage >::operator-- | ( | ) |
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 previous 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.
1.9.3