ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageReverseConstIterator.h>
Multi-dimensional image iterator.
ImageReverseConstIterator is a templated class to represent a multi-dimensional iterator. ImageReverseConstIterator is templated over the dimension of the image and the data type of the image.
ImageReverseConstIterator is a base class for all the reverse image iterators. It provides the basic construction and comparison operations. However, it does not provide mechanisms for moving the iterator. A subclass of ImageReverseConstIterator must be used to move the iterator.
ImageReverseConstIterator 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, ImageReverseConstIterator holds a reference to the image over which it is traversing.
ImageReverseConstIterator assumes a particular layout of the image data. In particular, the data is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.
Definition at line 87 of file itkImageReverseConstIterator.h.
Public Types | |
typedef TImage::AccessorFunctorType | AccessorFunctorType |
typedef TImage::AccessorType | AccessorType |
typedef TImage | ImageType |
typedef TImage::IndexType | IndexType |
typedef TImage::InternalPixelType | InternalPixelType |
typedef TImage::OffsetType | OffsetType |
typedef TImage::PixelContainer | PixelContainer |
typedef PixelContainer::Pointer | PixelContainerPointer |
typedef TImage::PixelType | PixelType |
typedef TImage::RegionType | RegionType |
typedef ImageReverseConstIterator | Self |
typedef TImage::SizeType | SizeType |
Public Member Functions | |
ImageReverseConstIterator (const Self &it) | |
ImageReverseConstIterator (const ImageType *ptr, const RegionType ®ion) | |
virtual | ~ImageReverseConstIterator () |
ImageReverseConstIterator () | |
typedef TImage::AccessorFunctorType itk::ImageReverseConstIterator< TImage >::AccessorFunctorType |
Functor to choose the appropriate accessor. (for Image vs VectorImage)
Definition at line 132 of file itkImageReverseConstIterator.h.
typedef TImage::AccessorType itk::ImageReverseConstIterator< TImage >::AccessorType |
Accessor type that convert data between internal and external representations.
Definition at line 129 of file itkImageReverseConstIterator.h.
typedef TImage itk::ImageReverseConstIterator< TImage >::ImageType |
Image typedef support.
Definition at line 113 of file itkImageReverseConstIterator.h.
typedef TImage::IndexType itk::ImageReverseConstIterator< TImage >::IndexType |
Index typedef support.
Definition at line 101 of file itkImageReverseConstIterator.h.
typedef TImage::InternalPixelType itk::ImageReverseConstIterator< TImage >::InternalPixelType |
Internal Pixel Type
Definition at line 122 of file itkImageReverseConstIterator.h.
typedef TImage::OffsetType itk::ImageReverseConstIterator< TImage >::OffsetType |
Offset typedef support.
Definition at line 107 of file itkImageReverseConstIterator.h.
typedef TImage::PixelContainer itk::ImageReverseConstIterator< TImage >::PixelContainer |
PixelContainer typedef support. Used to refer to the container for the pixel data. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.
Definition at line 118 of file itkImageReverseConstIterator.h.
typedef PixelContainer::Pointer itk::ImageReverseConstIterator< TImage >::PixelContainerPointer |
Definition at line 119 of file itkImageReverseConstIterator.h.
typedef TImage::PixelType itk::ImageReverseConstIterator< TImage >::PixelType |
External Pixel Type
Definition at line 125 of file itkImageReverseConstIterator.h.
typedef TImage::RegionType itk::ImageReverseConstIterator< TImage >::RegionType |
Region typedef support.
Definition at line 110 of file itkImageReverseConstIterator.h.
typedef ImageReverseConstIterator itk::ImageReverseConstIterator< TImage >::Self |
Standard class typedefs.
Definition at line 91 of file itkImageReverseConstIterator.h.
typedef TImage::SizeType itk::ImageReverseConstIterator< TImage >::SizeType |
Size typedef support.
Definition at line 104 of file itkImageReverseConstIterator.h.
|
inline |
Default Constructor. Need to provide a default constructor since we provide a copy constructor.
Definition at line 136 of file itkImageReverseConstIterator.h.
|
inlinevirtual |
Default Destructor.
Definition at line 147 of file itkImageReverseConstIterator.h.
|
inline |
Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.
Definition at line 151 of file itkImageReverseConstIterator.h.
References itk::ImageReverseConstIterator< TImage >::m_BeginOffset, itk::ImageReverseConstIterator< TImage >::m_Buffer, itk::ImageReverseConstIterator< TImage >::m_EndOffset, itk::ImageReverseConstIterator< TImage >::m_Image, itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_PixelAccessor, itk::ImageReverseConstIterator< TImage >::m_PixelAccessorFunctor, and itk::ImageReverseConstIterator< TImage >::m_Region.
|
inline |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
Definition at line 168 of file itkImageReverseConstIterator.h.
|
inline |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 202 of file itkImageReverseConstIterator.h.
References itk::ImageConstIterator< TImage >::GetImage(), itk::ImageConstIterator< TImage >::GetIndex(), and itk::ImageConstIterator< TImage >::GetRegion().
|
inline |
Get the pixel value
Definition at line 319 of file itkImageReverseConstIterator.h.
|
inlinestatic |
Get the dimension (size) of the index.
Definition at line 280 of file itkImageReverseConstIterator.h.
|
inline |
Get the index. This provides a read only reference to the index. This causes the index to be calculated from pointer arithmetic and is therefore an expensive operation.
Definition at line 305 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageRegionReverseConstIterator< TImage >::operator--().
|
inline |
Get the region that this iterator walks. ImageReverseConstIterators know the beginning and the end of the region of the image to iterate over.
Definition at line 315 of file itkImageReverseConstIterator.h.
|
inline |
Move an iterator to the beginning of the region. "Begin" for a reverse iterator is the last pixel in the region.
Definition at line 348 of file itkImageReverseConstIterator.h.
|
inline |
Move an iterator to the end of the region. "End" for a reverse iterator is defined as one pixel before the first pixel in the region.
Definition at line 360 of file itkImageReverseConstIterator.h.
|
inline |
Is the iterator at the beginning of the (reverse) region? "Begin" for a reverse iterator is the last pixel in the region.
Definition at line 367 of file itkImageReverseConstIterator.h.
|
inline |
Is the iterator at the end of the (reverse) region? "End" for a reverse iterator is one pixel before the first pixel in the region.
Definition at line 374 of file itkImageReverseConstIterator.h.
itk::ImageReverseConstIterator< TImage >::itkLegacyMacro | ( | Self Begin() | const | ) |
Return an iterator for the beginning of the region. "Begin" for a reverse iterator is the last pixel in the region.
itk::ImageReverseConstIterator< TImage >::itkLegacyMacro | ( | Self End() | const | ) |
Return an iterator for the end of the region. "End" for a reverse iterator is one pixel before the first pixel in the region.
|
inline |
Comparison operator. Two iterators are the same if they "point to" the same memory location
Definition at line 286 of file itkImageReverseConstIterator.h.
References itk::ImageReverseConstIterator< TImage >::m_Buffer, and itk::ImageReverseConstIterator< TImage >::m_Offset.
|
inline |
operator= is provided to make sure the handle to the image is properly reference counted.
Definition at line 232 of file itkImageReverseConstIterator.h.
References itk::ImageReverseConstIterator< TImage >::m_BeginOffset, itk::ImageReverseConstIterator< TImage >::m_Buffer, itk::ImageReverseConstIterator< TImage >::m_EndOffset, itk::ImageReverseConstIterator< TImage >::m_Image, itk::ImageReverseConstIterator< TImage >::m_Offset, itk::ImageReverseConstIterator< TImage >::m_PixelAccessor, and itk::ImageReverseConstIterator< TImage >::m_Region.
|
inline |
operator= is provided to make sure the handle to the image is properly reference counted.
Definition at line 249 of file itkImageReverseConstIterator.h.
References itk::ImageConstIterator< TImage >::GetImage(), itk::ImageConstIterator< TImage >::GetIndex(), and itk::ImageConstIterator< TImage >::GetRegion().
|
inline |
Comparison operator. Two iterators are the same if they "point to" the same memory location
Definition at line 295 of file itkImageReverseConstIterator.h.
References itk::ImageReverseConstIterator< TImage >::m_Buffer, and itk::ImageReverseConstIterator< TImage >::m_Offset.
|
inline |
Set the pixel value
Definition at line 323 of file itkImageReverseConstIterator.h.
|
inlinevirtual |
Set the index. No bounds checking is performed.
Reimplemented in itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 310 of file itkImageReverseConstIterator.h.
|
inline |
Return a const reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.
Definition at line 332 of file itkImageReverseConstIterator.h.
|
inline |
Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.
Definition at line 338 of file itkImageReverseConstIterator.h.
|
static |
Dimension of the image 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 98 of file itkImageReverseConstIterator.h.
|
protected |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 385 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
|
protected |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 388 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator!=(), itk::ImageReverseConstIterator< TImage >::operator=(), and itk::ImageReverseConstIterator< TImage >::operator==().
|
protected |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 386 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
|
protected |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 380 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
|
protected |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 384 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator!=(), itk::ImageReverseConstIterator< TImage >::operator=(), and itk::ImageReverseConstIterator< TImage >::operator==().
|
protected |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 390 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
|
protected |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 391 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator().
|
protected |
Constructor that can be used to cast from an ImageConstIterator to an ImageRegionReverseIterator. Many routines return an ImageConstIterator but for a particular task, you may want an ImageRegionReverseIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageConstIterators and uses constructors to cast from an ImageConstIterator to a ImageRegionReverseIterator.
Definition at line 382 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().