itk::ImageIteratorWithIndex< TImage > Class Template Reference
[Image Iterators]
A base class for multi-dimensional iterators templated over image type that are designed to efficiently keep track of the iterator position. More...
#include <itkImageIteratorWithIndex.h>
Detailed Description
template<typename TImage>
class itk::ImageIteratorWithIndex< TImage >
A base class for multi-dimensional iterators templated over image type that are designed to efficiently keep track of the iterator position.
This class inherits from ImageConstIteratorWithIndex and only adds write-access functionality. See ImageConstIteratorWithIndex 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
Definition at line 67 of file itkImageIteratorWithIndex.h.
Member Typedef Documentation
typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType [inherited] |
Definition at line 132 of file itkImageConstIteratorWithIndex.h.
| typedef Superclass::AccessorType itk::ImageIteratorWithIndex< TImage >::AccessorType |
Accessor type that convert data between internal and external representations.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 97 of file itkImageIteratorWithIndex.h.
| typedef Superclass::ImageType itk::ImageIteratorWithIndex< TImage >::ImageType |
Image typedef support.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 92 of file itkImageIteratorWithIndex.h.
| typedef Superclass::IndexType itk::ImageIteratorWithIndex< TImage >::IndexType |
Inherit types from the superclass
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 85 of file itkImageIteratorWithIndex.h.
| typedef Superclass::IndexValueType itk::ImageIteratorWithIndex< TImage >::IndexValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 86 of file itkImageIteratorWithIndex.h.
| typedef Superclass::InternalPixelType itk::ImageIteratorWithIndex< TImage >::InternalPixelType |
Internal Pixel Type
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 95 of file itkImageIteratorWithIndex.h.
| typedef Superclass::OffsetType itk::ImageIteratorWithIndex< TImage >::OffsetType |
Type of the Offset taken from the image
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 89 of file itkImageIteratorWithIndex.h.
| typedef Superclass::OffsetValueType itk::ImageIteratorWithIndex< TImage >::OffsetValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 90 of file itkImageIteratorWithIndex.h.
| typedef Superclass::PixelContainer itk::ImageIteratorWithIndex< 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.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 93 of file itkImageIteratorWithIndex.h.
| typedef Superclass::PixelContainerPointer itk::ImageIteratorWithIndex< TImage >::PixelContainerPointer |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 94 of file itkImageIteratorWithIndex.h.
| typedef Superclass::PixelType itk::ImageIteratorWithIndex< TImage >::PixelType |
External Pixel Type
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 96 of file itkImageIteratorWithIndex.h.
| typedef Superclass::RegionType itk::ImageIteratorWithIndex< TImage >::RegionType |
Region typedef support.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 91 of file itkImageIteratorWithIndex.h.
| typedef ImageIteratorWithIndex itk::ImageIteratorWithIndex< TImage >::Self |
Standard class typedefs.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 72 of file itkImageIteratorWithIndex.h.
| typedef Superclass::SizeType itk::ImageIteratorWithIndex< TImage >::SizeType |
Size typedef support.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 87 of file itkImageIteratorWithIndex.h.
| typedef Superclass::SizeValueType itk::ImageIteratorWithIndex< TImage >::SizeValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 88 of file itkImageIteratorWithIndex.h.
| typedef ImageConstIteratorWithIndex<TImage> itk::ImageIteratorWithIndex< TImage >::Superclass |
Define the superclass
Definition at line 82 of file itkImageIteratorWithIndex.h.
Constructor & Destructor Documentation
| itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex | ( | ) |
Default Constructor. Need to provide a default constructor since we provide a copy constructor.
| itk::ImageIteratorWithIndex< TImage >::~ImageIteratorWithIndex | ( | ) | [inline] |
Default Destructor
Definition at line 105 of file itkImageIteratorWithIndex.h.
| itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex | ( | const Self & | it | ) |
Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.
| itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex | ( | TImage * | ptr, | |
| const RegionType & | region | |||
| ) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
| itk::ImageIteratorWithIndex< TImage >::ImageIteratorWithIndex | ( | const ImageConstIteratorWithIndex< TImage > & | it | ) | [protected] |
This constructor is declared protected in order to enforce const-correctness
Member Function Documentation
| Self itk::ImageConstIteratorWithIndex< TImage >::Begin | ( | void | ) | const [inherited] |
Move an iterator to the beginning of the region.
- Deprecated:
- Use GoToBegin() instead
| Self itk::ImageConstIteratorWithIndex< TImage >::End | ( | void | ) | const [inherited] |
Move an iterator to the End of the region.
- Deprecated:
- Use GoToReverseBegin() instead
| PixelType itk::ImageConstIteratorWithIndex< TImage >::Get | ( | void | ) | const [inline, inherited] |
Get the pixel value
Definition at line 237 of file itkImageConstIteratorWithIndex.h.
| static unsigned int itk::ImageConstIteratorWithIndex< TImage >::GetImageDimension | ( | ) | [inline, static, inherited] |
Get the dimension (size) of the index.
Definition at line 156 of file itkImageConstIteratorWithIndex.h.
| const IndexType& itk::ImageConstIteratorWithIndex< TImage >::GetIndex | ( | void | ) | const [inline, inherited] |
Get the index. This provides a read only reference to the index.
- See also:
- SetIndex
Definition at line 219 of file itkImageConstIteratorWithIndex.h.
Referenced by itk::ConstrainedRegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::PopulateListImage(), and itk::Statistics::JointDomainImageToListAdaptor< TImage >::Search().
| const RegionType& itk::ImageConstIteratorWithIndex< TImage >::GetRegion | ( | ) | const [inline, inherited] |
Get the region that this iterator walks. ImageIterators know the beginning and the end of the region of the image to iterate over.
Definition at line 224 of file itkImageConstIteratorWithIndex.h.
| void itk::ImageConstIteratorWithIndex< TImage >::GoToBegin | ( | void | ) | [inherited] |
Move an iterator to the beginning of the region.
Reimplemented in itk::ReflectiveImageRegionConstIterator< TImage >, itk::ImageRandomConstIteratorWithIndex< TImage >, and itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.
Referenced by itk::ConstrainedRegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::PopulateListImage(), and itk::Statistics::JointDomainImageToListAdaptor< TImage >::Search().
| void itk::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin | ( | void | ) | [inherited] |
Move an iterator to the End of the region.
| bool itk::ImageConstIteratorWithIndex< TImage >::IsAtEnd | ( | void | ) | const [inline, inherited] |
Is the iterator at the end of the region?
Reimplemented in itk::ImageRandomConstIteratorWithIndex< TImage >, and itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.
Definition at line 267 of file itkImageConstIteratorWithIndex.h.
Referenced by itk::ConstrainedRegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::PopulateListImage(), and itk::Statistics::JointDomainImageToListAdaptor< TImage >::Search().
| bool itk::ImageConstIteratorWithIndex< TImage >::IsAtReverseEnd | ( | void | ) | const [inline, inherited] |
Is the iterator at the beginning of the region?
Definition at line 261 of file itkImageConstIteratorWithIndex.h.
| bool itk::ImageConstIteratorWithIndex< TImage >::operator!= | ( | const Self & | it | ) | const [inline, inherited] |
Comparison operator. Two iterators are the same if they "point to" the same memory location
Definition at line 162 of file itkImageConstIteratorWithIndex.h.
| bool itk::ImageConstIteratorWithIndex< TImage >::operator< | ( | const Self & | it | ) | const [inline, inherited] |
Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.
Definition at line 190 of file itkImageConstIteratorWithIndex.h.
| bool itk::ImageConstIteratorWithIndex< TImage >::operator<= | ( | const Self & | it | ) | const [inline, inherited] |
Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.
Definition at line 180 of file itkImageConstIteratorWithIndex.h.
| Self& itk::ImageIteratorWithIndex< TImage >::operator= | ( | const ImageConstIteratorWithIndex< TImage > & | it | ) | [protected] |
This constructor is declared protected in order to enforce const-correctness
| Self& itk::ImageIteratorWithIndex< TImage >::operator= | ( | const Self & | it | ) |
operator= is provided to make sure the handle to the image is properly reference counted.
| bool itk::ImageConstIteratorWithIndex< TImage >::operator== | ( | const Self & | it | ) | const [inline, inherited] |
Comparison operator. Two iterators are the same if they "point to" the same memory location
Definition at line 171 of file itkImageConstIteratorWithIndex.h.
| bool itk::ImageConstIteratorWithIndex< TImage >::operator> | ( | const Self & | it | ) | const [inline, inherited] |
Comparison operator. An iterator is "greater than" another if it "points to" a higher location.
Definition at line 210 of file itkImageConstIteratorWithIndex.h.
| bool itk::ImageConstIteratorWithIndex< TImage >::operator>= | ( | const Self & | it | ) | const [inline, inherited] |
Comparison operator. An iterator is "greater than" another if it "points to" a higher location.
Definition at line 200 of file itkImageConstIteratorWithIndex.h.
| bool itk::ImageConstIteratorWithIndex< TImage >::Remaining | ( | ) | [inline, inherited] |
Are there data remainning in the region ?
Definition at line 273 of file itkImageConstIteratorWithIndex.h.
| void itk::ImageIteratorWithIndex< TImage >::Set | ( | const PixelType & | value | ) | const [inline] |
Set the pixel value
Definition at line 121 of file itkImageIteratorWithIndex.h.
| void itk::ImageConstIteratorWithIndex< TImage >::SetIndex | ( | const IndexType & | ind | ) | [inline, inherited] |
Set the index. No bounds checking is performed.
- See also:
- GetIndex
Definition at line 229 of file itkImageConstIteratorWithIndex.h.
| const PixelType& itk::ImageConstIteratorWithIndex< TImage >::Value | ( | void | ) | const [inline, inherited] |
Return a const reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.
Definition at line 243 of file itkImageConstIteratorWithIndex.h.
| PixelType& itk::ImageIteratorWithIndex< 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 127 of file itkImageIteratorWithIndex.h.
Member Data Documentation
const unsigned int itk::ImageConstIteratorWithIndex< TImage >::ImageDimension = TImage::ImageDimension [static, inherited] |
Dimension of the image 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.
Reimplemented in itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.
Definition at line 101 of file itkImageConstIteratorWithIndex.h.
const unsigned int itk::ImageIteratorWithIndex< TImage >::ImageIteratorDimension = TImage::ImageDimension [static] |
Dimension of the image 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 79 of file itkImageIteratorWithIndex.h.
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Begin [protected, inherited] |
Definition at line 292 of file itkImageConstIteratorWithIndex.h.
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_BeginIndex [protected, inherited] |
Definition at line 282 of file itkImageConstIteratorWithIndex.h.
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_End [protected, inherited] |
Definition at line 293 of file itkImageConstIteratorWithIndex.h.
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_EndIndex [protected, inherited] |
Definition at line 283 of file itkImageConstIteratorWithIndex.h.
TImage::ConstWeakPointer itk::ImageConstIteratorWithIndex< TImage >::m_Image [protected, inherited] |
Definition at line 279 of file itkImageConstIteratorWithIndex.h.
unsigned long itk::ImageConstIteratorWithIndex< TImage >::m_OffsetTable[ImageDimension+1] [protected, inherited] |
Definition at line 289 of file itkImageConstIteratorWithIndex.h.
AccessorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessor [protected, inherited] |
Definition at line 297 of file itkImageConstIteratorWithIndex.h.
AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessorFunctor [protected, inherited] |
Definition at line 298 of file itkImageConstIteratorWithIndex.h.
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Position [protected, inherited] |
Definition at line 291 of file itkImageConstIteratorWithIndex.h.
Referenced by itk::ImageConstIteratorWithIndex< TImageType >::operator!=(), itk::ImageConstIteratorWithIndex< TImageType >::operator<(), itk::ImageConstIteratorWithIndex< TImageType >::operator<=(), itk::ImageConstIteratorWithIndex< TImageType >::operator==(), itk::ImageConstIteratorWithIndex< TImageType >::operator>(), and itk::ImageConstIteratorWithIndex< TImageType >::operator>=().
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_PositionIndex [protected, inherited] |
Definition at line 281 of file itkImageConstIteratorWithIndex.h.
RegionType itk::ImageConstIteratorWithIndex< TImage >::m_Region [protected, inherited] |
Definition at line 287 of file itkImageConstIteratorWithIndex.h.
bool itk::ImageConstIteratorWithIndex< TImage >::m_Remaining [protected, inherited] |
Definition at line 295 of file itkImageConstIteratorWithIndex.h.
The documentation for this class was generated from the following file:
