#include <itkImageConstIterator.h>
Inheritance diagram for itk::ImageConstIterator< TImage >:
[NOHEADER] | |
ImageConstIterator (const ImageType *ptr, const RegionType ®ion) | |
Self & | operator= (const Self &it) |
unsigned int | GetImageIteratorDimension () |
Public Types | |
typedef ImageConstIterator | Self |
typedef TImage::IndexType | IndexType |
typedef TImage::IndexValueType | IndexValueType |
typedef TImage::SizeType | SizeType |
typedef TImage::SizeValueType | SizeValueType |
typedef TImage::OffsetType | OffsetType |
typedef TImage::OffsetValueType | OffsetValueType |
typedef TImage::RegionType | RegionType |
typedef TImage | ImageType |
typedef TImage::PixelContainer | PixelContainer |
typedef PixelContainer::Pointer | PixelContainerPointer |
typedef TImage::InternalPixelType | InternalPixelType |
typedef TImage::PixelType | PixelType |
typedef TImage::AccessorType | AccessorType |
Public Member Functions | |
itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension) | |
virtual | ~ImageConstIterator () |
ImageConstIterator (const Self &it) | |
const IndexType | GetIndex () const |
virtual void | SetIndex (const IndexType &ind) |
const RegionType & | GetRegion () const |
const ImageType * | GetImage () const |
PixelType | Get (void) const |
const PixelType & | Value (void) const |
Self | Begin (void) const |
void | GoToBegin () |
Self | End (void) const |
void | GoToEnd () |
bool | IsAtBegin (void) const |
bool | IsAtEnd (void) const |
ImageConstIterator () | |
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 |
Protected Attributes | |
TImage::ConstWeakPointer | m_Image |
RegionType | m_Region |
unsigned long | m_Offset |
unsigned long | m_BeginOffset |
unsigned long | m_EndOffset |
const InternalPixelType * | m_Buffer |
AccessorType | m_PixelAccessor |
ImageConstIterator is a templated class to represent a multi-dimensional iterator. ImageConstIterator is templated over the type of the image to be iterated over.
ImageConstIterator is a base class for all the image iterators. It provides the basic construction and comparison operations. However, it does not provide mechanisms for moving the iterator. A subclass of ImageConstIterator must be used to move the iterator.
ImageConstIterator 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, ImageConstIterator holds a reference to the image over which it is traversing.
ImageConstIterator 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.
ConstShapedNeighborhoodIterator
CorrespondenceDataStructureIterator
FloodFilledFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalIterator
FloodFilledSpatialFunctionConditionalConstIterator
FloodFilledSpatialFunctionConditionalIterator
ImageLinearConstIteratorWithIndex
ImageRandomConstIteratorWithIndex
ImageRegionConstIteratorWithIndex
ImageRegionExclusionConstIteratorWithIndex
ImageRegionExclusionIteratorWithIndex
ImageRegionReverseConstIterator
Definition at line 84 of file itkImageConstIterator.h.
|
Accessor type that convert data between internal and external representations. Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 129 of file itkImageConstIterator.h. |
|
Image typedef support. Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 113 of file itkImageConstIterator.h. |
|
Index typedef support. Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 98 of file itkImageConstIterator.h. |
|
Reimplemented in itk::ImageIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 99 of file itkImageConstIterator.h. |
|
Internal Pixel Type Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 122 of file itkImageConstIterator.h. |
|
Offset typedef support. Reimplemented in itk::ImageIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 106 of file itkImageConstIterator.h. |
|
Reimplemented in itk::ImageIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 107 of file itkImageConstIterator.h. |
|
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 in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 118 of file itkImageConstIterator.h. |
|
Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 119 of file itkImageConstIterator.h. |
|
External Pixel Type Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 125 of file itkImageConstIterator.h. |
|
Region typedef support. Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 110 of file itkImageConstIterator.h. |
|
Standard class typedefs. Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 88 of file itkImageConstIterator.h. Referenced by itk::ImageConstIterator< TImage >::Get(), itk::ImageConstIterator< TImage >::GetImageIteratorDimension(), itk::ImageConstIterator< TImage >::operator>=(), and itk::ImageConstIterator< TImage >::~ImageConstIterator(). |
|
Size typedef support. Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 102 of file itkImageConstIterator.h. |
|
Reimplemented in itk::ImageIterator< TImage >, and itk::ImageRegionIterator< TImage >. Definition at line 103 of file itkImageConstIterator.h. |
|
Default Constructor. Need to provide a default constructor since we provide a copy constructor. Definition at line 133 of file itkImageConstIterator.h. |
|
Default Destructor. Definition at line 146 of file itkImageConstIterator.h. References itk::ImageConstIterator< TImage >::Self. |
|
Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted. Definition at line 150 of file itkImageConstIterator.h. References itk::ImageConstIterator< TImage >::m_BeginOffset, itk::ImageConstIterator< TImage >::m_Buffer, itk::ImageConstIterator< TImage >::m_EndOffset, itk::ImageConstIterator< TImage >::m_Image, itk::ImageConstIterator< TImage >::m_Offset, itk::ImageConstIterator< TImage >::m_PixelAccessor, and itk::ImageConstIterator< TImage >::m_Region. |
|
Constructor establishes an iterator to walk a particular image and a particular region of that image. Definition at line 165 of file itkImageConstIterator.h. |
|
Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.
Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. |
|
Return an iterator for the end of the region. "End" is defined as one pixel past the last pixel of the region.
Reimplemented in itk::ImageIterator< TImage >, itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionIterator< TImage >. |
|
Get the pixel value Definition at line 307 of file itkImageConstIterator.h. References itk::ImageConstIterator< TImage >::Self. Referenced by itk::ImageConstIterator< TImage >::GetRegion(), and itk::ImageReverseConstIterator< TImage >::SetIndex(). |
|
Get the image that this iterator walks. Reimplemented in itk::ImageIterator< TImage >. Definition at line 303 of file itkImageConstIterator.h. |
|
Get the dimension (size) of the index. Definition at line 218 of file itkImageConstIterator.h. References itk::ImageConstIterator< TImage >::Self. |
|
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 289 of file itkImageConstIterator.h. Referenced by itk::ImageRegionConstIterator< TImage >::ImageRegionConstIterator(). |
|
Get the region that this iterator walks. ImageConstIterators know the beginning and the end of the region of the image to iterate over. Definition at line 299 of file itkImageConstIterator.h. References itk::ImageConstIterator< TImage >::Get(). |
|
Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region. Reimplemented in itk::ImageRegionConstIterator< TImage >. Definition at line 324 of file itkImageConstIterator.h. |
|
Move an iterator to the end of the region. "End" is defined as one pixel past the last pixel of the region. Reimplemented in itk::ImageRegionConstIterator< TImage >. Definition at line 337 of file itkImageConstIterator.h. |
|
Is the iterator at the beginning of the region? "Begin" is defined as the first pixel in the region. Definition at line 344 of file itkImageConstIterator.h. |
|
Is the iterator at the end of the region? "End" is defined as one pixel past the last pixel of the region. Definition at line 351 of file itkImageConstIterator.h. |
|
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. Reimplemented in itk::ImageIterator< TImage >. |
|
Comparison operator. Two iterators are the same if they "point to" the same memory location Definition at line 224 of file itkImageConstIterator.h. |
|
Comparison operator. An iterator is "less than" another if it "points to" a lower memory location. Definition at line 255 of file itkImageConstIterator.h. |
|
Comparison operator. An iterator is "less than" another if it "points to" a lower memory location. Definition at line 244 of file itkImageConstIterator.h. |
|
operator= is provided to make sure the handle to the image is properly reference counted. Reimplemented in itk::ImageIterator< TImage >. Definition at line 203 of file itkImageConstIterator.h. |
|
Comparison operator. Two iterators are the same if they "point to" the same memory location Definition at line 234 of file itkImageConstIterator.h. |
|
Comparison operator. An iterator is "greater than" another if it "points to" a higher location. Definition at line 277 of file itkImageConstIterator.h. |
|
Comparison operator. An iterator is "greater than" another if it "points to" a higher location. Definition at line 266 of file itkImageConstIterator.h. References itk::ImageConstIterator< TImage >::m_Buffer, itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageConstIterator< TImage >::Self. |
|
Set the index. No bounds checking is performed.
Reimplemented in itk::ImageRegionConstIterator< TImage >. Definition at line 294 of file itkImageConstIterator.h. |
|
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 313 of file itkImageConstIterator.h. |
|
Definition at line 362 of file itkImageConstIterator.h. Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(). |
|
Definition at line 365 of file itkImageConstIterator.h. Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(), and itk::ImageConstIterator< TImage >::operator>=(). |
|
Definition at line 363 of file itkImageConstIterator.h. Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(). |
|
Definition at line 358 of file itkImageConstIterator.h. Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(). |
|
Definition at line 361 of file itkImageConstIterator.h. Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(), and itk::ImageConstIterator< TImage >::operator>=(). |
|
Definition at line 367 of file itkImageConstIterator.h. Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(). |
|
Definition at line 359 of file itkImageConstIterator.h. Referenced by itk::ImageConstIterator< TImage >::ImageConstIterator(). |