ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageScanlineConstIterator.h>
A multi-dimensional iterator templated over image type that walks a region of pixels, scanline by scanline or in the direction of the fastest axis.
The itk::ImageScanlineConstIterator is optimized for iteration speed and is the first choice for pixel-wise operations on an image. The following is sample usage:
Iterating beyond the and of a line results it undefined behavior.
Definition at line 58 of file itkImageScanlineConstIterator.h.
Public Member Functions | |
virtual const char * | GetNameOfClass () const |
void | GoToBegin () |
void | GoToBeginOfLine (void) |
void | GoToEnd () |
void | GoToEndOfLine (void) |
ImageScanlineConstIterator (const ImageIterator< TImage > &it) | |
ImageScanlineConstIterator (const ImageConstIterator< TImage > &it) | |
bool | IsAtEndOfLine (void) |
ImageScanlineConstIterator () | |
ImageScanlineConstIterator (const ImageType *ptr, const RegionType ®ion) | |
void | SetIndex (const IndexType &ind) |
void | NextLine (void) |
Self & | operator++ () |
Self & | operator-- () |
Public Member Functions inherited from itk::ImageConstIterator< TImage > | |
ImageConstIterator (const Self &it) | |
virtual | ~ImageConstIterator () |
ImageConstIterator () | |
ImageConstIterator (const ImageType *ptr, const RegionType ®ion) | |
Self & | operator= (const Self &it) |
virtual void | SetRegion (const RegionType ®ion) |
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 |
const IndexType | GetIndex () const |
const RegionType & | GetRegion () const |
const ImageType * | GetImage () const |
PixelType | Get (void) const |
const PixelType & | Value (void) const |
itkLegacyMacro (Self Begin(void) const) | |
void | GoToBegin () |
itkLegacyMacro (Self End(void) const) | |
void | GoToEnd () |
bool | IsAtBegin (void) const |
bool | IsAtEnd (void) const |
Static Public Attributes | |
static const unsigned int | ImageIteratorDimension = Superclass::ImageIteratorDimension |
Static Public Attributes inherited from itk::ImageConstIterator< TImage > | |
static const unsigned int | ImageIteratorDimension = TImage::ImageDimension |
Protected Attributes | |
OffsetValueType | m_SpanBeginOffset |
OffsetValueType | m_SpanEndOffset |
Protected Attributes inherited from itk::ImageConstIterator< TImage > | |
TImage::ConstWeakPointer | m_Image |
RegionType | m_Region |
OffsetValueType | m_Offset |
OffsetValueType | m_BeginOffset |
OffsetValueType | m_EndOffset |
const InternalPixelType * | m_Buffer |
AccessorType | m_PixelAccessor |
AccessorFunctorType | m_PixelAccessorFunctor |
Private Member Functions | |
void | Increment () |
typedef Superclass::AccessorType itk::ImageScanlineConstIterator< TImage >::AccessorType |
Definition at line 88 of file itkImageScanlineConstIterator.h.
typedef Superclass::ImageType itk::ImageScanlineConstIterator< TImage >::ImageType |
Definition at line 83 of file itkImageScanlineConstIterator.h.
typedef Superclass::IndexType itk::ImageScanlineConstIterator< TImage >::IndexType |
Index typedef support. While these were already typdef'ed in the superclass, they need to be redone here for this subclass to compile properly with gcc.Types inherited from the Superclass
Definition at line 79 of file itkImageScanlineConstIterator.h.
typedef Superclass::InternalPixelType itk::ImageScanlineConstIterator< TImage >::InternalPixelType |
Definition at line 86 of file itkImageScanlineConstIterator.h.
typedef Superclass::OffsetType itk::ImageScanlineConstIterator< TImage >::OffsetType |
Definition at line 81 of file itkImageScanlineConstIterator.h.
typedef Superclass::PixelContainer itk::ImageScanlineConstIterator< TImage >::PixelContainer |
Definition at line 84 of file itkImageScanlineConstIterator.h.
typedef Superclass::PixelContainerPointer itk::ImageScanlineConstIterator< TImage >::PixelContainerPointer |
Definition at line 85 of file itkImageScanlineConstIterator.h.
typedef Superclass::PixelType itk::ImageScanlineConstIterator< TImage >::PixelType |
Definition at line 87 of file itkImageScanlineConstIterator.h.
typedef Superclass::RegionType itk::ImageScanlineConstIterator< TImage >::RegionType |
Definition at line 82 of file itkImageScanlineConstIterator.h.
typedef ImageScanlineConstIterator itk::ImageScanlineConstIterator< TImage >::Self |
Standard class typedef.
Definition at line 63 of file itkImageScanlineConstIterator.h.
typedef Superclass::SizeType itk::ImageScanlineConstIterator< TImage >::SizeType |
Definition at line 80 of file itkImageScanlineConstIterator.h.
typedef ImageConstIterator< TImage > itk::ImageScanlineConstIterator< TImage >::Superclass |
Definition at line 64 of file itkImageScanlineConstIterator.h.
|
inline |
Default constructor. Needed since we provide a cast constructor.
Definition at line 94 of file itkImageScanlineConstIterator.h.
References itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset.
|
inline |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
Definition at line 104 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::m_BeginOffset, itk::ImageConstIterator< TImage >::m_Region, itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset.
|
inline |
Constructor that can be used to cast from an ImageIterator to an ImageScanlineConstIterator. Many routines return an ImageIterator, but for a particular task, you may want an ImageScanlineConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageScanlineConstIterator.
Definition at line 118 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::GetIndex(), itk::ImageConstIterator< TImage >::m_Offset, itk::ImageConstIterator< TImage >::m_Region, itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset, itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset, and itk::ImageConstIterator< TImage >::operator=().
|
inline |
Constructor that can be used to cast from an ImageConstIterator to an ImageScanlineConstIterator. Many routines return an ImageIterator, but for a particular task, you may want an ImageScanlineConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageScanlineConstIterator.
Definition at line 135 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::GetIndex(), itk::ImageConstIterator< TImage >::m_Offset, itk::ImageConstIterator< TImage >::m_Region, itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset, itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset, and itk::ImageConstIterator< TImage >::operator=().
|
virtual |
Run-time type information (and related methods).
|
inline |
Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.
Definition at line 148 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::GoToBegin(), itk::ImageConstIterator< TImage >::m_BeginOffset, itk::ImageConstIterator< TImage >::m_Region, itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset.
|
inline |
Go to the beginning pixel of the current line.
Definition at line 178 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset.
|
inline |
Move an iterator to the end of the region.
"End" is defined as one pixel past the last pixel of the region.
Definition at line 162 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::GoToEnd(), itk::ImageConstIterator< TImage >::m_EndOffset, itk::ImageConstIterator< TImage >::m_Region, itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset.
|
inline |
Go to the past end pixel of the current line.
Definition at line 191 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset.
|
private |
Referenced by itk::ImageScanlineConstIterator< TImage >::NextLine().
|
inline |
Test if the index is at the end of line
Definition at line 198 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset.
Referenced by itk::ImageScanlineConstIterator< TImage >::operator++(), and itk::ImageScanlineConstIterator< TImage >::operator--().
|
inline |
Go to the next line.
The iterator always moves to the beginning of the next line. If the iterator is on the last scanline then no action is performed. \sa operator++ \sa IsAtEndOfLine
Definition at line 226 of file itkImageScanlineConstIterator.h.
References itk::ImageScanlineConstIterator< TImage >::Increment().
|
inline |
Increment (prefix) along the scanline the iterator's index.
If the iterator is at the end of the scanline ( one past the last valid element in the row ), then the results are undefined. Which means is may assert in debug mode or result in an undefined iterator which may have unknown consequences if used.
Definition at line 239 of file itkImageScanlineConstIterator.h.
References itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine(), and itk::ImageConstIterator< TImage >::m_Offset.
|
inline |
decrement (prefix) along the scanline the iterator's index.
Definition at line 250 of file itkImageScanlineConstIterator.h.
References itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine(), and itk::ImageConstIterator< TImage >::m_Offset.
|
inlinevirtual |
Set the index without bounds checking.
This is overridden from the parent because we have an extra ivar. \sa GetIndex
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 209 of file itkImageScanlineConstIterator.h.
References itk::ImageConstIterator< TImage >::m_Offset, itk::ImageConstIterator< TImage >::m_Region, itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset, itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset, and itk::ImageConstIterator< TImage >::SetIndex().
|
static |
Dimension of the image that 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 71 of file itkImageScanlineConstIterator.h.
|
protected |
Definition at line 260 of file itkImageScanlineConstIterator.h.
Referenced by itk::ImageScanlineConstIterator< TImage >::GoToBegin(), itk::ImageScanlineConstIterator< TImage >::GoToBeginOfLine(), itk::ImageScanlineConstIterator< TImage >::GoToEnd(), itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator(), and itk::ImageScanlineConstIterator< TImage >::SetIndex().
|
protected |
Definition at line 261 of file itkImageScanlineConstIterator.h.
Referenced by itk::ImageScanlineConstIterator< TImage >::GoToBegin(), itk::ImageScanlineConstIterator< TImage >::GoToEnd(), itk::ImageScanlineConstIterator< TImage >::GoToEndOfLine(), itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator(), itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine(), and itk::ImageScanlineConstIterator< TImage >::SetIndex().