itk::ImageRegionIteratorWithIndex< TImage > Class Template Reference
[Image Iterators]
#include <itkImageRegionIteratorWithIndex.h>
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
ConstShapedNeighborhoodIterator
CorrespondenceDataStructureIterator
FloodFilledFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalIterator
FloodFilledSpatialFunctionConditionalConstIterator
FloodFilledSpatialFunctionConditionalIterator
ImageLinearConstIteratorWithIndex
ImageRandomConstIteratorWithIndex
ImageRegionConstIteratorWithIndex
ImageRegionExclusionConstIteratorWithIndex
ImageRegionExclusionIteratorWithIndex
ImageRegionReverseConstIterator
- Examples:
-
Iterators/ImageRegionIteratorWithIndex.cxx, and Testing/Code/Common/itkVectorImageTest.cxx.
Definition at line 65 of file itkImageRegionIteratorWithIndex.h.
Member Typedef Documentation
typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType [inherited] |
Definition at line 132 of file itkImageConstIteratorWithIndex.h.
| typedef Superclass::AccessorType itk::ImageRegionIteratorWithIndex< TImage >::AccessorType |
Accessor type that convert data between internal and external representations.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 85 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::ImageType itk::ImageRegionIteratorWithIndex< 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 Image back to itk::Image to that is it not confused with ImageIterator::Image.
Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.
Definition at line 80 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::IndexType itk::ImageRegionIteratorWithIndex< TImage >::IndexType |
Types inherited from the Superclass
Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.
Definition at line 73 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::IndexValueType itk::ImageRegionIteratorWithIndex< TImage >::IndexValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 74 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::InternalPixelType itk::ImageRegionIteratorWithIndex< TImage >::InternalPixelType |
Internal Pixel Type
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 83 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::OffsetType itk::ImageRegionIteratorWithIndex< TImage >::OffsetType |
Type of the Offset taken from the image
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 77 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::OffsetValueType itk::ImageRegionIteratorWithIndex< TImage >::OffsetValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 78 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::PixelContainer itk::ImageRegionIteratorWithIndex< 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::ImageRegionConstIteratorWithIndex< TImage >.
Definition at line 81 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::PixelContainerPointer itk::ImageRegionIteratorWithIndex< TImage >::PixelContainerPointer |
Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.
Definition at line 82 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::PixelType itk::ImageRegionIteratorWithIndex< TImage >::PixelType |
External Pixel Type
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 84 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::RegionType itk::ImageRegionIteratorWithIndex< 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 is it not confused with ImageIterator::Index.
Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.
Definition at line 79 of file itkImageRegionIteratorWithIndex.h.
| typedef ImageRegionIteratorWithIndex itk::ImageRegionIteratorWithIndex< TImage >::Self |
Standard class typedefs.
Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.
Definition at line 69 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::SizeType itk::ImageRegionIteratorWithIndex< TImage >::SizeType |
Size typedef support.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 75 of file itkImageRegionIteratorWithIndex.h.
| typedef Superclass::SizeValueType itk::ImageRegionIteratorWithIndex< TImage >::SizeValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 76 of file itkImageRegionIteratorWithIndex.h.
| typedef ImageRegionConstIteratorWithIndex<TImage> itk::ImageRegionIteratorWithIndex< TImage >::Superclass |
Reimplemented from itk::ImageRegionConstIteratorWithIndex< TImage >.
Definition at line 70 of file itkImageRegionIteratorWithIndex.h.
Constructor & Destructor Documentation
| itk::ImageRegionIteratorWithIndex< TImage >::ImageRegionIteratorWithIndex | ( | ) |
Default constructor. Needed since we provide a cast constructor.
| 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.
| 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.
| 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
| 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.
| itk::ImageConstIteratorWithIndex< TImage >::itkStaticConstMacro | ( | ImageDimension | , | |
| unsigned | int, | |||
| TImage::ImageDimension | ||||
| ) | [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.
| 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.
| Self& itk::ImageRegionConstIteratorWithIndex< TImage >::operator++ | ( | ) | [inherited] |
Increment (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the end of the row of the region to the beginning of the next row of the region) up until the iterator tries to moves past the last pixel of the region. Here, the iterator will be set to be one pixel past the end of the region.
- See also:
- operator--
| Self& itk::ImageRegionConstIteratorWithIndex< TImage >::operator-- | ( | ) | [inherited] |
Decrement (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the beginning of the row of the region to the end of the previous row of the region) up until the iterator tries to moves past the first pixel of the region. Here, the iterator will be set to be one pixel past the beginning of the region.
- See also:
- operator++
| 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::ImageRegionIteratorWithIndex< TImage >::operator= | ( | const ImageRegionConstIteratorWithIndex< TImage > & | it | ) | [protected] |
the construction from a const iterator is declared protected in order to enforce const correctness.
| 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::ImageRegionIteratorWithIndex< TImage >::Set | ( | const PixelType & | value | ) | const [inline] |
Set the pixel value
Definition at line 104 of file itkImageRegionIteratorWithIndex.h.
Referenced by itk::ConstrainedRegionBasedLevelSetFunctionSharedData< TInputImage, TFeatureImage, TSingleData >::PopulateListImage().
| 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::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 110 of file itkImageRegionIteratorWithIndex.h.
Member Data Documentation
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:
