ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Private Member Functions | List of all members
itk::ImageScanlineConstIterator< TImage > Class Template Reference

#include <itkImageScanlineConstIterator.h>

+ Inheritance diagram for itk::ImageScanlineConstIterator< TImage >:
+ Collaboration diagram for itk::ImageScanlineConstIterator< TImage >:

Detailed Description

template<typename TImage>
class itk::ImageScanlineConstIterator< TImage >

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. This iterator is preferred over the older ImageRegionConstIterator even when knowledge of the current line state is not desired because of its speed.

The following is sample usage:

while ( !it.IsAtEnd() )
{
while ( !it.IsAtEndOfLine() )
{
*it += 100.0;
++it;
}
it.NextLine();
}
*

Iterating beyond the end of a line results it undefined behavior.

See Also
ImageScanlineIterator
ImageRegionConstIterator
ImageConstIterator

Definition at line 63 of file itkImageScanlineConstIterator.h.

Public Types

typedef Superclass::AccessorType AccessorType
 
typedef Superclass::ImageType ImageType
 
typedef Superclass::IndexType IndexType
 
typedef
Superclass::InternalPixelType 
InternalPixelType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::PixelContainer PixelContainer
 
typedef
Superclass::PixelContainerPointer 
PixelContainerPointer
 
typedef Superclass::PixelType PixelType
 
typedef Superclass::RegionType RegionType
 
typedef ImageScanlineConstIterator Self
 
typedef Superclass::SizeType SizeType
 
typedef ImageConstIterator
< TImage > 
Superclass
 
- Public Types inherited from itk::ImageConstIterator< TImage >
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 ImageConstIterator Self
 
typedef TImage::SizeType SizeType
 

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 &region)
 
void SetIndex (const IndexType &ind) override
 
void NextLine (void)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIterator< TImage >
 ImageConstIterator (const Self &it)
 
 itkTypeMacroNoParent (ImageConstIterator)
 
virtual ~ImageConstIterator ()
 
 ImageConstIterator ()
 
 ImageConstIterator (const ImageType *ptr, const RegionType &region)
 
Selfoperator= (const Self &it)
 
virtual void SetRegion (const RegionType &region)
 
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 RegionTypeGetRegion () const
 
const ImageTypeGetImage () const
 
PixelType Get (void) const
 
const PixelTypeValue (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 InternalPixelTypem_Buffer
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 

Private Member Functions

void Increment ()
 

Member Typedef Documentation

template<typename TImage>
typedef Superclass::AccessorType itk::ImageScanlineConstIterator< TImage >::AccessorType

Definition at line 93 of file itkImageScanlineConstIterator.h.

template<typename TImage>
typedef Superclass::ImageType itk::ImageScanlineConstIterator< TImage >::ImageType

Definition at line 88 of file itkImageScanlineConstIterator.h.

template<typename TImage>
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 84 of file itkImageScanlineConstIterator.h.

Definition at line 91 of file itkImageScanlineConstIterator.h.

template<typename TImage>
typedef Superclass::OffsetType itk::ImageScanlineConstIterator< TImage >::OffsetType

Definition at line 86 of file itkImageScanlineConstIterator.h.

template<typename TImage>
typedef Superclass::PixelContainer itk::ImageScanlineConstIterator< TImage >::PixelContainer

Definition at line 89 of file itkImageScanlineConstIterator.h.

Definition at line 90 of file itkImageScanlineConstIterator.h.

template<typename TImage>
typedef Superclass::PixelType itk::ImageScanlineConstIterator< TImage >::PixelType

Definition at line 92 of file itkImageScanlineConstIterator.h.

template<typename TImage>
typedef Superclass::RegionType itk::ImageScanlineConstIterator< TImage >::RegionType

Definition at line 87 of file itkImageScanlineConstIterator.h.

template<typename TImage>
typedef ImageScanlineConstIterator itk::ImageScanlineConstIterator< TImage >::Self

Standard class typedef.

Definition at line 68 of file itkImageScanlineConstIterator.h.

template<typename TImage>
typedef Superclass::SizeType itk::ImageScanlineConstIterator< TImage >::SizeType

Definition at line 85 of file itkImageScanlineConstIterator.h.

template<typename TImage>
typedef ImageConstIterator< TImage > itk::ImageScanlineConstIterator< TImage >::Superclass

Definition at line 69 of file itkImageScanlineConstIterator.h.

Constructor & Destructor Documentation

template<typename TImage>
itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator ( )
inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 99 of file itkImageScanlineConstIterator.h.

References itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset, and itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset.

template<typename TImage>
itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator ( const ImageType ptr,
const RegionType region 
)
inline
template<typename TImage>
itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator ( const ImageIterator< TImage > &  it)
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 123 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=().

template<typename TImage>
itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator ( const ImageConstIterator< TImage > &  it)
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 140 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=().

Member Function Documentation

template<typename TImage>
virtual const char* itk::ImageScanlineConstIterator< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

template<typename TImage>
void itk::ImageScanlineConstIterator< TImage >::GoToBegin ( void  )
inline
template<typename TImage>
void itk::ImageScanlineConstIterator< TImage >::GoToBeginOfLine ( void  )
inline

Go to the beginning pixel of the current line.

See Also
operator++
operator--
NextLine
IsAtEndOfLine

Definition at line 183 of file itkImageScanlineConstIterator.h.

References itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset.

template<typename TImage>
void itk::ImageScanlineConstIterator< TImage >::GoToEnd ( void  )
inline
template<typename TImage>
void itk::ImageScanlineConstIterator< TImage >::GoToEndOfLine ( void  )
inline

Go to the past end pixel of the current line.

See Also
GoToBeginOfLine
operator++
operator--
NextLine
IsAtEndOfLine

Definition at line 196 of file itkImageScanlineConstIterator.h.

References itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset.

template<typename TImage>
void itk::ImageScanlineConstIterator< TImage >::Increment ( )
private
template<typename TImage>
bool itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine ( void  )
inline
template<typename TImage>
void itk::ImageScanlineConstIterator< TImage >::NextLine ( void  )
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 231 of file itkImageScanlineConstIterator.h.

References itk::ImageScanlineConstIterator< TImage >::Increment().

Referenced by itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::ThreadedGenerateData().

template<typename TImage>
Self& itk::ImageScanlineConstIterator< TImage >::operator++ ( )
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 244 of file itkImageScanlineConstIterator.h.

References itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine(), and itk::ImageConstIterator< TImage >::m_Offset.

template<typename TImage>
Self& itk::ImageScanlineConstIterator< TImage >::operator-- ( )
inline

decrement (prefix) along the scanline the iterator's index.

Definition at line 255 of file itkImageScanlineConstIterator.h.

References itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine(), and itk::ImageConstIterator< TImage >::m_Offset.

template<typename TImage>
void itk::ImageScanlineConstIterator< TImage >::SetIndex ( const IndexType ind)
inlineoverridevirtual

Member Data Documentation

template<typename TImage>
const unsigned int itk::ImageScanlineConstIterator< TImage >::ImageIteratorDimension = Superclass::ImageIteratorDimension
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 76 of file itkImageScanlineConstIterator.h.

template<typename TImage>
OffsetValueType itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset
protected
template<typename TImage>
OffsetValueType itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset
protected

The documentation for this class was generated from the following file: