itk::ImageRegionReverseIterator< TImage > Class Template Reference
[Image Iterators]
Multi-dimensional image iterator which only walks a region. More...
#include <itkImageRegionReverseIterator.h>
Detailed Description
template<typename TImage>
class itk::ImageRegionReverseIterator< TImage >
Multi-dimensional image iterator which only walks a region.
ImageRegionReverseIterator is a templated class to represent a multi-dimensional iterator. ImageRegionReverseIterator is templated over the image type ImageRegionReverseIterator is constrained to walk only within the specified region and along a line parallel to one of the coordinate axis.
Most of the functionality is inherited from the ImageRegionReverseConstIterator. The current class only adds write access to image pixels.
- MORE INFORMATION
- 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 http://www.itk.org.
- See also:
- ImageConstIterator
- ConditionalConstIterator
- ConstNeighborhoodIterator
- ConstShapedNeighborhoodIterator
- ConstSliceIterator
- CorrespondenceDataStructureIterator
- FloodFilledFunctionConditionalConstIterator
- FloodFilledImageFunctionConditionalConstIterator
- FloodFilledImageFunctionConditionalIterator
- FloodFilledSpatialFunctionConditionalConstIterator
- FloodFilledSpatialFunctionConditionalIterator
- ImageConstIterator
- ImageConstIteratorWithIndex
- ImageIterator
- ImageIteratorWithIndex
- ImageLinearConstIteratorWithIndex
- ImageLinearIteratorWithIndex
- ImageRandomConstIteratorWithIndex
- ImageRandomIteratorWithIndex
- ImageRegionConstIterator
- ImageRegionConstIteratorWithIndex
- ImageRegionExclusionConstIteratorWithIndex
- ImageRegionExclusionIteratorWithIndex
- ImageRegionIterator
- ImageRegionIteratorWithIndex
- ImageRegionReverseConstIterator
- ImageRegionReverseIterator
- ImageReverseConstIterator
- ImageReverseIterator
- ImageSliceConstIteratorWithIndex
- ImageSliceIteratorWithIndex
- NeighborhoodIterator
- PathConstIterator
- PathIterator
- ShapedNeighborhoodIterator
- SliceIterator
- ImageConstIteratorWithIndex
Definition at line 67 of file itkImageRegionReverseIterator.h.
Member Typedef Documentation
typedef TImage::AccessorFunctorType itk::ImageReverseConstIterator< TImage >::AccessorFunctorType [inherited] |
Functor to choose the appropriate accessor. (for Image vs VectorImage)
Definition at line 135 of file itkImageReverseConstIterator.h.
| typedef Superclass::AccessorType itk::ImageRegionReverseIterator< TImage >::AccessorType |
Accessor type that convert data between internal and external representations.
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 87 of file itkImageRegionReverseIterator.h.
| typedef Superclass::ImageType itk::ImageRegionReverseIterator< TImage >::ImageType |
Image typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 82 of file itkImageRegionReverseIterator.h.
| typedef Superclass::IndexType itk::ImageRegionReverseIterator< TImage >::IndexType |
Types inherited from the Superclass
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 75 of file itkImageRegionReverseIterator.h.
| typedef Superclass::IndexValueType itk::ImageRegionReverseIterator< TImage >::IndexValueType |
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 76 of file itkImageRegionReverseIterator.h.
| typedef Superclass::InternalPixelType itk::ImageRegionReverseIterator< TImage >::InternalPixelType |
Internal Pixel Type
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 85 of file itkImageRegionReverseIterator.h.
| typedef Superclass::OffsetType itk::ImageRegionReverseIterator< TImage >::OffsetType |
Offset typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 79 of file itkImageRegionReverseIterator.h.
| typedef Superclass::OffsetValueType itk::ImageRegionReverseIterator< TImage >::OffsetValueType |
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 80 of file itkImageRegionReverseIterator.h.
| typedef Superclass::PixelContainer itk::ImageRegionReverseIterator< 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.
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 83 of file itkImageRegionReverseIterator.h.
| typedef Superclass::PixelContainerPointer itk::ImageRegionReverseIterator< TImage >::PixelContainerPointer |
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 84 of file itkImageRegionReverseIterator.h.
| typedef Superclass::PixelType itk::ImageRegionReverseIterator< TImage >::PixelType |
External Pixel Type
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 86 of file itkImageRegionReverseIterator.h.
| typedef Superclass::RegionType itk::ImageRegionReverseIterator< TImage >::RegionType |
Region typedef support.
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 81 of file itkImageRegionReverseIterator.h.
| typedef ImageRegionReverseIterator itk::ImageRegionReverseIterator< TImage >::Self |
Standard class typedefs.
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 71 of file itkImageRegionReverseIterator.h.
| typedef Superclass::SizeType itk::ImageRegionReverseIterator< TImage >::SizeType |
Size typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 77 of file itkImageRegionReverseIterator.h.
| typedef Superclass::SizeValueType itk::ImageRegionReverseIterator< TImage >::SizeValueType |
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 78 of file itkImageRegionReverseIterator.h.
| typedef ImageRegionReverseConstIterator<TImage> itk::ImageRegionReverseIterator< TImage >::Superclass |
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
Definition at line 72 of file itkImageRegionReverseIterator.h.
Member Enumeration Documentation
anonymous enum [inherited] |
Dimension of the image the iterator walks. This enum is needed so that 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.
- Enumerator:
Definition at line 113 of file itkImageRegionReverseConstIterator.h.
Constructor & Destructor Documentation
| itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator | ( | ) |
Default constructor. Needed since we provide a cast constructor.
| itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator | ( | ImageType * | ptr, | |
| const RegionType & | region | |||
| ) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
| itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator | ( | const ImageConstIterator< TImage > & | it | ) |
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.
| itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator | ( | const ImageRegionReverseConstIterator< TImage > & | it | ) | [protected] |
the construction from a const iterator is declared protected in order to enforce const correctness.
Member Function Documentation
| Self itk::ImageRegionReverseIterator< TImage >::Begin | ( | void | ) | const |
Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.
- Deprecated:
- Use GoToBegin() instead
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
| Self itk::ImageRegionReverseIterator< TImage >::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.
- Deprecated:
- Use GoToEnd() instead
Reimplemented from itk::ImageRegionReverseConstIterator< TImage >.
| const PixelType itk::ImageReverseConstIterator< TImage >::Get | ( | void | ) | const [inline, inherited] |
Get the pixel value
Definition at line 323 of file itkImageReverseConstIterator.h.
| static unsigned int itk::ImageReverseConstIterator< TImage >::GetImageIteratorDimension | ( | ) | [inline, static, inherited] |
Get the dimension (size) of the index.
Definition at line 283 of file itkImageReverseConstIterator.h.
References HardConnectedComponentImageFilter::ImageDimension.
| const IndexType itk::ImageReverseConstIterator< TImage >::GetIndex | ( | void | ) | [inline, inherited] |
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.
- See also:
- SetIndex
Definition at line 308 of file itkImageReverseConstIterator.h.
| virtual const char* itk::ImageRegionReverseConstIterator< TImage >::GetNameOfClass | ( | ) | const [virtual, inherited] |
Run-time type information (and related methods).
| const RegionType& itk::ImageReverseConstIterator< TImage >::GetRegion | ( | ) | const [inline, inherited] |
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 319 of file itkImageReverseConstIterator.h.
| void itk::ImageRegionReverseConstIterator< TImage >::GoToBegin | ( | void | ) | [inline, inherited] |
Move an iterator to the beginning of the region. "Begin" for a reverse iterator is the last pixel in the region.
Reimplemented from itk::ImageReverseConstIterator< TImage >.
Definition at line 213 of file itkImageRegionReverseConstIterator.h.
| void itk::ImageRegionReverseConstIterator< TImage >::GoToEnd | ( | void | ) | [inline, inherited] |
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.
Reimplemented from itk::ImageReverseConstIterator< TImage >.
Definition at line 224 of file itkImageRegionReverseConstIterator.h.
| bool itk::ImageReverseConstIterator< TImage >::IsAtBegin | ( | void | ) | [inline, inherited] |
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 371 of file itkImageReverseConstIterator.h.
| bool itk::ImageReverseConstIterator< TImage >::IsAtEnd | ( | void | ) | [inline, inherited] |
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 378 of file itkImageReverseConstIterator.h.
| bool itk::ImageReverseConstIterator< TImage >::operator!= | ( | const Self & | it | ) | const [inline, inherited] |
Comparison operator. Two iterators are the same if they "point to" the same memory location
Definition at line 289 of file itkImageReverseConstIterator.h.
References itk::ImageReverseConstIterator< TImage >::m_Buffer, and itk::ImageReverseConstIterator< TImage >::m_Offset.
| Self& itk::ImageRegionReverseConstIterator< TImage >::operator++ | ( | ) | [inline, inherited] |
iterator's index. For a reverse iterator, this moves backwards through the region. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the start of the row of the region to the end of the previous row of the region) up until the iterator tries to moves before the first pixel of the region. Here, the iterator will be set to be one pixel before the start of the region.
- See also:
- operator++(int).
Definition at line 266 of file itkImageRegionReverseConstIterator.h.
| Self& itk::ImageRegionReverseConstIterator< TImage >::operator-- | ( | ) | [inline, inherited] |
Decrement (prefix) the fastest moving dimension of the iterator's index. For a reverse iterator, this moves forward through the region. 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 start 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.
- See also:
- operator--(int)
Definition at line 324 of file itkImageRegionReverseConstIterator.h.
References itk::ImageConstIterator< TImage >::GetIndex().
| Self& itk::ImageRegionReverseIterator< TImage >::operator= | ( | const ImageRegionReverseConstIterator< TImage > & | it | ) | [protected] |
the construction from a const iterator is declared protected in order to enforce const correctness.
| bool itk::ImageReverseConstIterator< TImage >::operator== | ( | const Self & | it | ) | const [inline, inherited] |
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.
| void itk::ImageReverseConstIterator< TImage >::Set | ( | const PixelType & | value | ) | const [inline, inherited] |
Set the pixel value
Definition at line 327 of file itkImageReverseConstIterator.h.
| void itk::ImageRegionReverseIterator< TImage >::Set | ( | const PixelType & | value | ) | const [inline] |
Set the pixel value
Definition at line 106 of file itkImageRegionReverseIterator.h.
| virtual void itk::ImageReverseConstIterator< TImage >::SetIndex | ( | const IndexType & | ind | ) | [inline, virtual, inherited] |
Set the index. No bounds checking is performed.
- See also:
- GetIndex
Definition at line 313 of file itkImageReverseConstIterator.h.
| void itk::ImageRegionReverseConstIterator< TImage >::SetIndex | ( | const IndexType & | ind | ) | [inline, inherited] |
Set the index. No bounds checking is performed. This is overridden from the parent because we have an extra ivar.
- See also:
- GetIndex
Definition at line 248 of file itkImageRegionReverseConstIterator.h.
| const PixelType& itk::ImageReverseConstIterator< TImage >::Value | ( | void | ) | const [inline, inherited] |
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 336 of file itkImageReverseConstIterator.h.
| PixelType& itk::ImageRegionReverseIterator< TImage >::Value | ( | void | ) | [inline] |
Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.
Reimplemented from itk::ImageReverseConstIterator< TImage >.
Definition at line 112 of file itkImageRegionReverseIterator.h.
Member Data Documentation
unsigned long itk::ImageReverseConstIterator< TImage >::m_BeginOffset [protected, inherited] |
Get the pixel value
Definition at line 388 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
const InternalPixelType* itk::ImageReverseConstIterator< TImage >::m_Buffer [protected, inherited] |
Get the pixel value
Definition at line 391 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator!=(), itk::ImageReverseConstIterator< TImage >::operator=(), and itk::ImageReverseConstIterator< TImage >::operator==().
unsigned long itk::ImageReverseConstIterator< TImage >::m_EndOffset [protected, inherited] |
Get the pixel value
Definition at line 389 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
ImageType::ConstWeakPointer itk::ImageReverseConstIterator< TImage >::m_Image [protected, inherited] |
Get the pixel value
Definition at line 384 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
unsigned long itk::ImageReverseConstIterator< TImage >::m_Offset [protected, inherited] |
Get the pixel value
Definition at line 387 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), itk::ImageReverseConstIterator< TImage >::operator!=(), itk::ImageReverseConstIterator< TImage >::operator=(), and itk::ImageReverseConstIterator< TImage >::operator==().
AccessorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessor [protected, inherited] |
Get the pixel value
Definition at line 393 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
AccessorFunctorType itk::ImageReverseConstIterator< TImage >::m_PixelAccessorFunctor [protected, inherited] |
Get the pixel value
Definition at line 394 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator().
RegionType itk::ImageReverseConstIterator< TImage >::m_Region [protected, inherited] |
Get the pixel value
Definition at line 385 of file itkImageReverseConstIterator.h.
Referenced by itk::ImageReverseConstIterator< TImage >::ImageReverseConstIterator(), and itk::ImageReverseConstIterator< TImage >::operator=().
unsigned long itk::ImageRegionReverseConstIterator< TImage >::m_SpanBeginOffset [protected, inherited] |
Definition at line 375 of file itkImageRegionReverseConstIterator.h.
unsigned long itk::ImageRegionReverseConstIterator< TImage >::m_SpanEndOffset [protected, inherited] |
Definition at line 376 of file itkImageRegionReverseConstIterator.h.
The documentation for this class was generated from the following file:
