ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | List of all members
itk::ImageLinearIteratorWithIndex< TImage > Class Template Reference

#include <itkImageLinearIteratorWithIndex.h>

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

Detailed Description

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

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

This iterator is a subclass of itk::ImageLinearConstIteratorWithIndex that adds write-access functionality. Please see itk::ImageLinearConstIteratorWithIndex for more information.

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
Examples:
ImageLinearIteratorWithIndex.cxx, and itkVectorImageTest.cxx.

Definition at line 67 of file itkImageLinearIteratorWithIndex.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
ImageLinearIteratorWithIndex 
Self
 
typedef Superclass::SizeType SizeType
 
typedef
ImageLinearConstIteratorWithIndex
< TImage > 
Superclass
 
- Public Types inherited from itk::ImageLinearConstIteratorWithIndex< TImage >
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

 ImageLinearIteratorWithIndex ()
 
 ImageLinearIteratorWithIndex (ImageType *ptr, const RegionType &region)
 
 ImageLinearIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
 
void Set (const PixelType &value) const
 
PixelTypeValue (void)
 
- Public Member Functions inherited from itk::ImageLinearConstIteratorWithIndex< TImage >
unsigned int GetDirection ()
 
void GoToBeginOfLine (void)
 
void GoToEndOfLine (void)
 
void GoToReverseBeginOfLine (void)
 
 ImageLinearConstIteratorWithIndex ()
 
 ImageLinearConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)
 
 ImageLinearConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
bool IsAtEndOfLine (void)
 
bool IsAtReverseEndOfLine (void)
 
void NextLine (void)
 
void PreviousLine (void)
 
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)
 
void GoToReverseBegin (void)
 
 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)
 

Protected Member Functions

 ImageLinearIteratorWithIndex (const ImageLinearConstIteratorWithIndex< TImage > &it)
 
Selfoperator= (const ImageLinearConstIteratorWithIndex< TImage > &it)
 

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 Superclass::AccessorType itk::ImageLinearIteratorWithIndex< TImage >::AccessorType

Definition at line 84 of file itkImageLinearIteratorWithIndex.h.

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

Definition at line 79 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>
typedef Superclass::IndexType itk::ImageLinearIteratorWithIndex< TImage >::IndexType

Types inherited from the Superclass

Definition at line 75 of file itkImageLinearIteratorWithIndex.h.

Definition at line 82 of file itkImageLinearIteratorWithIndex.h.

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

Definition at line 77 of file itkImageLinearIteratorWithIndex.h.

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

Definition at line 80 of file itkImageLinearIteratorWithIndex.h.

Definition at line 81 of file itkImageLinearIteratorWithIndex.h.

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

Definition at line 83 of file itkImageLinearIteratorWithIndex.h.

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

Definition at line 78 of file itkImageLinearIteratorWithIndex.h.

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

Standard class typedefs.

Definition at line 71 of file itkImageLinearIteratorWithIndex.h.

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

Definition at line 76 of file itkImageLinearIteratorWithIndex.h.

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

Definition at line 72 of file itkImageLinearIteratorWithIndex.h.

Constructor & Destructor Documentation

template<typename TImage>
itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex ( )

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>
itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex ( 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::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex ( const ImageIteratorWithIndex< TImage > &  it)

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

template<typename TImage>
itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex ( const ImageLinearConstIteratorWithIndex< TImage > &  it)
protected

the construction from a const iterator is declared protected in order to enforce const correctness.

Member Function Documentation

template<typename TImage>
Self& itk::ImageLinearIteratorWithIndex< TImage >::operator= ( const ImageLinearConstIteratorWithIndex< TImage > &  it)
protected

the construction from a const iterator is declared protected in order to enforce const correctness.

template<typename TImage>
void itk::ImageLinearIteratorWithIndex< TImage >::Set ( const PixelType value) const
inline

Set the pixel value

Definition at line 102 of file itkImageLinearIteratorWithIndex.h.

template<typename TImage>
PixelType& itk::ImageLinearIteratorWithIndex< 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.

Definition at line 108 of file itkImageLinearIteratorWithIndex.h.


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