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

#include <itkImageLinearConstIteratorWithIndex.h>

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

Detailed Description

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

A multi-dimensional image iterator that visits image pixels within a region in a "scan-line" order.

ImageLinearConstIteratorWithIndex is templated over image type and is constrained to walk within a specified image region. It is designed for line-by-line processing of images. This iterator walks a linear path along a selected image direction that is parallel to one of the coordinate axes of the image. The iterator conceptually breaks the image into a set of parallel lines that span the selected image dimension.

ImageLinearConstIteratorWithIndex assumes a particular layout of the image data. The is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.

operator++ provides a simple syntax for walking around a region of a multidimensional image. operator++ iterates across a preselected direction constraining the movement to within a region of image. The user can verify when the iterator reaches the boundary of the region along this direction, by calling the IsAtEndOfLine() method. Then it is possible to pass to the next line starting at the first pixel in the row that is part of the region by calling the NextLine() method.

This is the typical use of this iterator in a loop:

*
* ImageLinearConstIteratorWithIndex<ImageType> it( image, image->GetRequestedRegion() );
*
* it.SetDirection(2);
* it.GoToBegin();
* while( !it.IsAtEnd() )
* {
* while( !it.IsAtEndOfLine() )
* {
* value = it.Get(); // it.Set() doesn't exist in the Const Iterator
* ++it;
* }
* it.NextLine();
* }
*
*
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 https://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
Examples:
Examples/Iterators/ImageLinearIteratorWithIndex.cxx, and Examples/Iterators/ImageLinearIteratorWithIndex2.cxx.

Definition at line 101 of file itkImageLinearConstIteratorWithIndex.h.

Public Types

typedef TImage ImageType
 
typedef TImage::IndexType IndexType
 
typedef TImage::PixelContainer PixelContainer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef TImage::RegionType RegionType
 
typedef
ImageLinearConstIteratorWithIndex 
Self
 
typedef
ImageConstIteratorWithIndex
< TImage > 
Superclass
 
- Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
typedef TImage::AccessorFunctorType AccessorFunctorType
 
typedef TImage::AccessorType AccessorType
 
typedef TImage ImageType
 
typedef TImage::IndexType IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef TImage::InternalPixelType InternalPixelType
 
typedef TImage::OffsetType OffsetType
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef TImage::PixelContainer PixelContainer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef TImage::PixelType PixelType
 
typedef TImage::RegionType RegionType
 
typedef ImageConstIteratorWithIndex Self
 
typedef TImage::SizeType SizeType
 
typedef SizeType::SizeValueType SizeValueType
 

Public Member Functions

unsigned int GetDirection ()
 
void GoToBeginOfLine ()
 
void GoToEndOfLine ()
 
void GoToReverseBeginOfLine ()
 
 ImageLinearConstIteratorWithIndex ()
 
 ImageLinearConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
 
 ImageLinearConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
bool IsAtEndOfLine (void)
 
bool IsAtReverseEndOfLine (void)
 
void NextLine ()
 
void PreviousLine ()
 
void SetDirection (unsigned int direction)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType Get (void) const
 
const IndexTypeGetIndex () const
 
const RegionTypeGetRegion () const
 
void GoToBegin ()
 
void GoToReverseBegin ()
 
 ImageConstIteratorWithIndex ()
 
 ImageConstIteratorWithIndex (const Self &it)
 
 ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
bool IsAtEnd (void) const
 
bool IsAtReverseEnd (void) const
 
 itkLegacyMacro (Self Begin(void) const)
 
 itkLegacyMacro (Self End(void) const)
 
bool operator!= (const Self &it) const
 
bool operator< (const Self &it) const
 
bool operator<= (const Self &it) const
 
Selfoperator= (const Self &it)
 
bool operator== (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
bool Remaining ()
 
const PixelTypeValue (void) const
 
virtual ~ImageConstIteratorWithIndex ()
 
void SetIndex (const IndexType &ind)
 

Private Attributes

unsigned int m_Direction
 
OffsetValueType m_Jump
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static unsigned int GetImageDimension ()
 
- Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static const unsigned int ImageDimension = TImage::ImageDimension
 
- Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
const InternalPixelTypem_Begin
 
IndexType m_BeginIndex
 
const InternalPixelTypem_End
 
IndexType m_EndIndex
 
TImage::ConstWeakPointer m_Image
 
OffsetValueType m_OffsetTable [ImageDimension+1]
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 
const InternalPixelTypem_Position
 
IndexType m_PositionIndex
 
RegionType m_Region
 
bool m_Remaining
 

Member Typedef Documentation

template<typename TImage>
typedef TImage itk::ImageLinearConstIteratorWithIndex< 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. Note that we have to rescope Index back to itk::Index so that it is not confused with ImageIterator::Index.

Definition at line 124 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
typedef TImage::IndexType itk::ImageLinearConstIteratorWithIndex< TImage >::IndexType

Index 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. Note that we have to rescope Index back to itk::Index so that it is not confused with ImageIterator::Index.

Definition at line 112 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
typedef TImage::PixelContainer itk::ImageLinearConstIteratorWithIndex< 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.

Definition at line 129 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
typedef PixelContainer::Pointer itk::ImageLinearConstIteratorWithIndex< TImage >::PixelContainerPointer

Definition at line 130 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
typedef TImage::RegionType itk::ImageLinearConstIteratorWithIndex< TImage >::RegionType

Region 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. Note that we have to rescope Region back to itk::ImageRegion so that it is not confused with ImageIterator::Index.

Definition at line 118 of file itkImageLinearConstIteratorWithIndex.h.

Standard class typedefs.

Definition at line 105 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
typedef ImageConstIteratorWithIndex< TImage > itk::ImageLinearConstIteratorWithIndex< TImage >::Superclass

Definition at line 106 of file itkImageLinearConstIteratorWithIndex.h.

Constructor & Destructor Documentation

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

Default constructor. Needed since we provide a cast constructor.

Definition at line 133 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
itk::ImageLinearConstIteratorWithIndex< TImage >::ImageLinearConstIteratorWithIndex ( const ImageType ptr,
const RegionType region 
)

Constructor establishes an iterator to walk a particular image and a particular region of that image.

template<typename TImage>
itk::ImageLinearConstIteratorWithIndex< TImage >::ImageLinearConstIteratorWithIndex ( const ImageConstIteratorWithIndex< TImage > &  it)
inline

Constructor that can be used to cast from an ImageIterator to an ImageLinearConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageLinearConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageLinearConstIteratorWithIndex.

Definition at line 149 of file itkImageLinearConstIteratorWithIndex.h.

Member Function Documentation

template<typename TImage>
unsigned int itk::ImageLinearConstIteratorWithIndex< TImage >::GetDirection ( )
inline

get the direction of movement

Definition at line 198 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
void itk::ImageLinearConstIteratorWithIndex< TImage >::GoToBeginOfLine ( )

Go to the beginning pixel of the current line.

See Also
GoToReverseBeginOfLine
operator++
operator--
NextLine
IsAtEndOfLine
template<typename TImage>
void itk::ImageLinearConstIteratorWithIndex< TImage >::GoToEndOfLine ( )

Go to the past end pixel of the current line.

See Also
GoToBeginOfLine
operator++
operator--
NextLine
IsAtEndOfLine
template<typename TImage>
void itk::ImageLinearConstIteratorWithIndex< TImage >::GoToReverseBeginOfLine ( )

Go to the beginning pixel of the current line.

See Also
GoToBeginOfLine
operator++
operator--
NextLine
IsAtEndOfLine
template<typename TImage>
bool itk::ImageLinearConstIteratorWithIndex< TImage >::IsAtEndOfLine ( void  )
inline

Test if the index is at the end of line

Definition at line 173 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageLinearConstIteratorWithIndex< TImage >::IsAtReverseEndOfLine ( void  )
inline

Test if the index is at the begin of line

Definition at line 179 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage >
void itk::ImageLinearConstIteratorWithIndex< TImage >::NextLine ( void  )
inline

Go to the next line.

See Also
operator++
operator--
IsAtEndOfLine
PreviousLine
End

Definition at line 235 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
Self& itk::ImageLinearConstIteratorWithIndex< TImage >::operator++ ( )
inline

Increment (prefix) the selected dimension. No bounds checking is performed.

See Also
GetIndex
operator--

Definition at line 205 of file itkImageLinearConstIteratorWithIndex.h.

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

Decrement (prefix) the selected dimension. No bounds checking is performed.

See Also
GetIndex
operator++

Definition at line 215 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage >
void itk::ImageLinearConstIteratorWithIndex< TImage >::PreviousLine ( void  )
inline

Go to the previous line.

See Also
operator++
operator--
IsAtEndOfLine
NextLine
End

Definition at line 273 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
void itk::ImageLinearConstIteratorWithIndex< TImage >::SetDirection ( unsigned int  direction)
inline

Set the direction of movement

Definition at line 185 of file itkImageLinearConstIteratorWithIndex.h.

Member Data Documentation

template<typename TImage>
unsigned int itk::ImageLinearConstIteratorWithIndex< TImage >::m_Direction
private

Definition at line 225 of file itkImageLinearConstIteratorWithIndex.h.

template<typename TImage>
OffsetValueType itk::ImageLinearConstIteratorWithIndex< TImage >::m_Jump
private

Definition at line 224 of file itkImageLinearConstIteratorWithIndex.h.


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