ITK
6.0.0
Insight 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 | |
using | AccessorFunctorType = typename TImage::AccessorFunctorType |
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 = ImageReverseConstIterator |
using | SizeType = typename TImage::SizeType |
Public Member Functions | |
const PixelType | Get () const |
const IndexType | GetIndex () |
virtual const char * | GetNameOfClass () const |
const RegionType & | GetRegion () const |
void | GoToBegin () |
void | GoToEnd () |
ImageReverseConstIterator (const ImageType *ptr, const RegionType ®ion) | |
ImageReverseConstIterator (const Self &it) | |
bool | IsAtBegin () const |
bool | IsAtEnd () const |
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self) | |
bool | operator== (const Self &it) const |
void | Set (const PixelType &value) const |
virtual void | SetIndex (const IndexType &ind) |
const PixelType & | Value () |
const PixelType & | Value () const |
virtual | ~ImageReverseConstIterator ()=default |
ImageReverseConstIterator () | |
ImageReverseConstIterator (const ImageConstIterator< TImage > &it) | |
Self & | operator= (const Self &it) |
Self & | operator= (const ImageConstIterator< TImage > &it) |
Static Public Member Functions | |
static unsigned int | GetImageIteratorDimension () |
Static Public Attributes | |
static constexpr unsigned int | ImageIteratorDimension = TImage::ImageDimension |
Protected Attributes | |
SizeValueType | m_BeginOffset {} |
const InternalPixelType * | m_Buffer {} |
SizeValueType | m_EndOffset {} |
ImageType::ConstWeakPointer | m_Image {} |
SizeValueType | m_Offset {} |
AccessorType | m_PixelAccessor {} |
AccessorFunctorType | m_PixelAccessorFunctor {} |
RegionType | m_Region {} |
using itk::ImageReverseConstIterator< TImage >::AccessorFunctorType = typename TImage::AccessorFunctorType |
Functor to choose the appropriate accessor. (for Image vs VectorImage)
Definition at line 134 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::AccessorType = typename TImage::AccessorType |
Accessor type that convert data between internal and external representations.
Definition at line 131 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::ImageType = TImage |
Image type alias support
Definition at line 115 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::IndexType = typename TImage::IndexType |
Index type alias support
Definition at line 103 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::InternalPixelType = typename TImage::InternalPixelType |
Internal Pixel Type
Definition at line 124 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::OffsetType = typename TImage::OffsetType |
Offset type alias support
Definition at line 109 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< 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 120 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::PixelContainerPointer = typename PixelContainer::Pointer |
Definition at line 121 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::PixelType = typename TImage::PixelType |
External Pixel Type
Definition at line 127 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::RegionType = typename TImage::RegionType |
Region type alias support
Definition at line 112 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::Self = ImageReverseConstIterator |
Standard class type aliases.
Definition at line 91 of file itkImageReverseConstIterator.h.
using itk::ImageReverseConstIterator< TImage >::SizeType = typename TImage::SizeType |
Size type alias support
Definition at line 106 of file itkImageReverseConstIterator.h.
|
inline |
Default Constructor. Need to provide a default constructor since we provide a copy constructor.
Definition at line 138 of file itkImageReverseConstIterator.h.
|
virtualdefault |
Default Destructor.
|
inline |
Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.
Definition at line 155 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. Initializes the iterator at the begin of the region.
Definition at line 172 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 206 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 335 of file itkImageReverseConstIterator.h.
|
inlinestatic |
Get the dimension (size) of the index.
Definition at line 290 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 312 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageRegionReverseConstIterator< TImage >::operator++(), and itk::ImageRegionReverseConstIterator< TImage >::operator--().
|
virtual |
Reimplemented in itk::ImageRegionReverseConstIterator< TImage >.
|
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 328 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 368 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 376 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 384 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 392 of file itkImageReverseConstIterator.h.
itk::ImageReverseConstIterator< TImage >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION | ( | Self | ) |
|
inline |
operator= is provided to make sure the handle to the image is properly reference counted.
Definition at line 259 of file itkImageReverseConstIterator.h.
References itk::ImageConstIterator< TImage >::GetImage(), itk::ImageConstIterator< TImage >::GetIndex(), and itk::ImageConstIterator< TImage >::GetRegion().
|
inline |
operator= is provided to make sure the handle to the image is properly reference counted.
Definition at line 237 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 |
Comparison operator. Two iterators are the same if they "point to" the same memory location
Definition at line 298 of file itkImageReverseConstIterator.h.
References itk::ImageReverseConstIterator< TImage >::m_Buffer, and itk::ImageReverseConstIterator< TImage >::m_Offset.
|
inline |
Set the pixel value
Definition at line 342 of file itkImageReverseConstIterator.h.
|
inlinevirtual |
Set the index. No bounds checking is performed.
Reimplemented in itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 320 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 360 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 351 of file itkImageReverseConstIterator.h.
|
staticconstexpr |
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 97 of file itkImageReverseConstIterator.h.
|
protected |
Definition at line 403 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
|
protected |
Definition at line 406 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator=(), and itk::ImageReverseConstIterator< TImage >::operator==().
|
protected |
Definition at line 404 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
|
protected |
Definition at line 398 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
|
protected |
Definition at line 402 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator=(), and itk::ImageReverseConstIterator< TImage >::operator==().
|
protected |
Definition at line 408 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
|
protected |
Definition at line 409 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator().
|
protected |
Definition at line 400 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().