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

#include <itkImageRegionIteratorWithIndex.h>

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

Detailed Description

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

A multi-dimensional iterator templated over image type that walks pixels within a region and is specialized to keep track of its image index location.

This class is a specialization of ImageRegionConstIteratorWithIndex that adds write-access (the Set() method). Please see ImageRegionConstIteratorWithIndex 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
Wiki Examples:
Examples:
Examples/DataRepresentation/Image/ImageAdaptor1.cxx, Examples/Filtering/DigitallyReconstructedRadiograph1.cxx, Examples/Iterators/ImageRegionIteratorWithIndex.cxx, SphinxExamples/src/Segmentation/LevelSetsv4Visualization/VisualizeEvolvingDense2DLevelSetAsElevationMap/Code.cxx, SphinxExamples/src/Segmentation/LevelSetsv4Visualization/VisualizeEvolvingDense2DLevelSetZeroSet/Code.cxx, and WikiExamples/Iterators/ImageRegionIteratorWithIndex.cxx.

Definition at line 71 of file itkImageRegionIteratorWithIndex.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
ImageRegionIteratorWithIndex 
Self
 
typedef Superclass::SizeType SizeType
 
typedef
ImageRegionConstIteratorWithIndex
< TImage > 
Superclass
 
- Public Types inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
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
ImageRegionConstIteratorWithIndex 
Self
 
typedef Superclass::SizeType SizeType
 
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

 ImageRegionIteratorWithIndex ()
 
 ImageRegionIteratorWithIndex (TImage *ptr, const RegionType &region)
 
 ImageRegionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
 
void Set (const PixelType &value) const
 
PixelTypeValue (void)
 
- Public Member Functions inherited from itk::ImageRegionConstIteratorWithIndex< TImage >
 ImageRegionConstIteratorWithIndex ()
 
 ImageRegionConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
 ImageRegionConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)
 
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)
 

Protected Member Functions

 ImageRegionIteratorWithIndex (const ImageRegionConstIteratorWithIndex< TImage > &it)
 
Selfoperator= (const ImageRegionConstIteratorWithIndex< 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::ImageRegionIteratorWithIndex< TImage >::AccessorType

Definition at line 88 of file itkImageRegionIteratorWithIndex.h.

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

Definition at line 83 of file itkImageRegionIteratorWithIndex.h.

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

Types inherited from the Superclass

Definition at line 79 of file itkImageRegionIteratorWithIndex.h.

Definition at line 86 of file itkImageRegionIteratorWithIndex.h.

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

Definition at line 81 of file itkImageRegionIteratorWithIndex.h.

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

Definition at line 84 of file itkImageRegionIteratorWithIndex.h.

Definition at line 85 of file itkImageRegionIteratorWithIndex.h.

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

Definition at line 87 of file itkImageRegionIteratorWithIndex.h.

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

Definition at line 82 of file itkImageRegionIteratorWithIndex.h.

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

Standard class typedefs.

Definition at line 75 of file itkImageRegionIteratorWithIndex.h.

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

Definition at line 80 of file itkImageRegionIteratorWithIndex.h.

template<typename TImage>
typedef ImageRegionConstIteratorWithIndex< TImage > itk::ImageRegionIteratorWithIndex< TImage >::Superclass

Definition at line 76 of file itkImageRegionIteratorWithIndex.h.

Constructor & Destructor Documentation

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

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>
itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex ( TImage *  ptr,
const RegionType region 
)

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

template<typename TImage>
itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex ( const ImageIteratorWithIndex< TImage > &  it)

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

template<typename TImage>
itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex ( const ImageRegionConstIteratorWithIndex< 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::ImageRegionIteratorWithIndex< TImage >::operator= ( const ImageRegionConstIteratorWithIndex< TImage > &  it)
protected

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

template<typename TImage>
void itk::ImageRegionIteratorWithIndex< TImage >::Set ( const PixelType value) const
inline
template<typename TImage>
PixelType& itk::ImageRegionIteratorWithIndex< 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 112 of file itkImageRegionIteratorWithIndex.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.


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