itk::ImageIterator< TImage > Class Template Reference
[Image Iterators]
A multi-dimensional iterator templated over image type.
More...
#include <itkImageIterator.h>
Detailed Description
template<typename TImage>
class itk::ImageIterator< TImage >
A multi-dimensional iterator templated over image type.
This is a base class of ImageConstIterator that adds write-access functionality. Please see ImageConstIterator 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
Definition at line 63 of file itkImageIterator.h.
Member Typedef Documentation
typedef TImage ::AccessorFunctorType itk::ImageConstIterator< TImage >::AccessorFunctorType [inherited] |
Definition at line 131 of file itkImageConstIterator.h.
| typedef Superclass::AccessorType itk::ImageIterator< TImage >::AccessorType |
Accessor type that convert data between internal and external representations.
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 93 of file itkImageIterator.h.
| typedef Superclass::ImageType itk::ImageIterator< TImage >::ImageType |
Image typedef support.
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 88 of file itkImageIterator.h.
| typedef Superclass::IndexType itk::ImageIterator< TImage >::IndexType |
Inherit types from the superclass
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 81 of file itkImageIterator.h.
| typedef Superclass::IndexValueType itk::ImageIterator< TImage >::IndexValueType |
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 82 of file itkImageIterator.h.
| typedef Superclass::InternalPixelType itk::ImageIterator< TImage >::InternalPixelType |
Internal Pixel Type
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 91 of file itkImageIterator.h.
| typedef Superclass::OffsetType itk::ImageIterator< TImage >::OffsetType |
Offset typedef support.
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 85 of file itkImageIterator.h.
| typedef Superclass::OffsetValueType itk::ImageIterator< TImage >::OffsetValueType |
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 86 of file itkImageIterator.h.
| typedef Superclass::PixelContainer itk::ImageIterator< 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::ImageConstIterator< TImage >.
Definition at line 89 of file itkImageIterator.h.
| typedef Superclass::PixelContainerPointer itk::ImageIterator< TImage >::PixelContainerPointer |
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 90 of file itkImageIterator.h.
| typedef Superclass::PixelType itk::ImageIterator< TImage >::PixelType |
External Pixel Type
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 92 of file itkImageIterator.h.
| typedef Superclass::RegionType itk::ImageIterator< TImage >::RegionType |
Region typedef support.
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 87 of file itkImageIterator.h.
| typedef ImageIterator itk::ImageIterator< TImage >::Self |
Standard class typedefs.
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 68 of file itkImageIterator.h.
| typedef Superclass::SizeType itk::ImageIterator< TImage >::SizeType |
Size typedef support.
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 83 of file itkImageIterator.h.
| typedef Superclass::SizeValueType itk::ImageIterator< TImage >::SizeValueType |
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 84 of file itkImageIterator.h.
| typedef ImageConstIterator<TImage> itk::ImageIterator< TImage >::Superclass |
Define the superclass
Definition at line 78 of file itkImageIterator.h.
Constructor & Destructor Documentation
| itk::ImageIterator< TImage >::ImageIterator | ( | ) |
Default Constructor. Need to provide a default constructor since we provide a copy constructor.
| itk::ImageIterator< TImage >::~ImageIterator | ( | ) | [inline] |
Default Destructor
Definition at line 101 of file itkImageIterator.h.
| itk::ImageIterator< TImage >::ImageIterator | ( | const Self & | it | ) |
Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.
| itk::ImageIterator< TImage >::ImageIterator | ( | TImage * | ptr, | |
| const RegionType & | region | |||
| ) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
| itk::ImageIterator< TImage >::ImageIterator | ( | const ImageConstIterator< TImage > & | it | ) | [protected] |
This constructor is declared protected in order to enforce const-correctness
Member Function Documentation
| Self itk::ImageIterator< TImage >::Begin | ( | void | ) | const |
Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.
- Deprecated:
- Use GoToBegin() instead
Reimplemented from itk::ImageConstIterator< TImage >.
| Self itk::ImageIterator< TImage >::End | ( | void | ) | const |
Return an iterator for the end of the region. "End" is defined as one pixel past the last pixel of the region.
- Deprecated:
- Use GoToEnd() instead
Reimplemented from itk::ImageConstIterator< TImage >.
| PixelType itk::ImageConstIterator< TImage >::Get | ( | void | ) | const [inline, inherited] |
Get the pixel value
Definition at line 326 of file itkImageConstIterator.h.
| ImageType* itk::ImageIterator< TImage >::GetImage | ( | ) | const [inline] |
Get the image that this iterator walks.
Reimplemented from itk::ImageConstIterator< TImage >.
Definition at line 146 of file itkImageIterator.h.
| static unsigned int itk::ImageConstIterator< TImage >::GetImageIteratorDimension | ( | ) | [inline, static, inherited] |
Get the dimension (size) of the index.
Definition at line 237 of file itkImageConstIterator.h.
| const IndexType itk::ImageConstIterator< TImage >::GetIndex | ( | void | ) | const [inline, inherited] |
Get the index. This provides a read only reference to the index. This causes the index to be calculated from pointer arithmetic and is therefore an expensive operation.
- See also:
- SetIndex
Definition at line 308 of file itkImageConstIterator.h.
| const RegionType& itk::ImageConstIterator< TImage >::GetRegion | ( | ) | const [inline, inherited] |
Get the region that this iterator walks. ImageConstIterators know the beginning and the end of the region of the image to iterate over.
Definition at line 318 of file itkImageConstIterator.h.
| void itk::ImageConstIterator< TImage >::GoToBegin | ( | void | ) | [inline, inherited] |
Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.
Reimplemented in itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionConstIterator< TImage >.
Definition at line 343 of file itkImageConstIterator.h.
| void itk::ImageConstIterator< TImage >::GoToEnd | ( | void | ) | [inline, inherited] |
Move an iterator to the end of the region. "End" is defined as one pixel past the last pixel of the region.
Reimplemented in itk::ImageRegionConstIterator< TImage >, and itk::ImageRegionConstIterator< TImage >.
Definition at line 356 of file itkImageConstIterator.h.
| bool itk::ImageConstIterator< TImage >::IsAtBegin | ( | void | ) | const [inline, inherited] |
Is the iterator at the beginning of the region? "Begin" is defined as the first pixel in the region.
Definition at line 363 of file itkImageConstIterator.h.
| bool itk::ImageConstIterator< TImage >::IsAtEnd | ( | void | ) | const [inline, inherited] |
Is the iterator at the end of the region? "End" is defined as one pixel past the last pixel of the region.
Definition at line 370 of file itkImageConstIterator.h.
| itk::ImageIterator< TImage >::itkStaticConstMacro | ( | ImageIteratorDimension | , | |
| unsigned | int, | |||
| TImage::ImageDimension | ||||
| ) |
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 from itk::ImageConstIterator< TImage >.
| bool itk::ImageConstIterator< 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 243 of file itkImageConstIterator.h.
| bool itk::ImageConstIterator< 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 274 of file itkImageConstIterator.h.
| bool itk::ImageConstIterator< 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 263 of file itkImageConstIterator.h.
| Self& itk::ImageIterator< TImage >::operator= | ( | const ImageConstIterator< TImage > & | it | ) | [protected] |
This constructor is declared protected in order to enforce const-correctness
| Self& itk::ImageIterator< TImage >::operator= | ( | const Self & | it | ) |
operator= is provided to make sure the handle to the image is properly reference counted.
| bool itk::ImageConstIterator< 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 253 of file itkImageConstIterator.h.
| bool itk::ImageConstIterator< 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 296 of file itkImageConstIterator.h.
| bool itk::ImageConstIterator< 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 285 of file itkImageConstIterator.h.
| void itk::ImageIterator< TImage >::Set | ( | const PixelType & | value | ) | const [inline] |
Set the pixel value
Definition at line 117 of file itkImageIterator.h.
| virtual void itk::ImageConstIterator< TImage >::SetIndex | ( | const IndexType & | ind | ) | [inline, virtual, inherited] |
Set the index. No bounds checking is performed.
- See also:
- GetIndex
Reimplemented in itk::ImageRegionConstIterator< TImage >.
Definition at line 313 of file itkImageConstIterator.h.
| const PixelType& itk::ImageConstIterator< 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 332 of file itkImageConstIterator.h.
| PixelType& itk::ImageIterator< 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 128 of file itkImageIterator.h.
Member Data Documentation
unsigned long itk::ImageConstIterator< TImage >::m_BeginOffset [protected, inherited] |
Definition at line 381 of file itkImageConstIterator.h.
const InternalPixelType* itk::ImageConstIterator< TImage >::m_Buffer [protected, inherited] |
Definition at line 384 of file itkImageConstIterator.h.
unsigned long itk::ImageConstIterator< TImage >::m_EndOffset [protected, inherited] |
Definition at line 382 of file itkImageConstIterator.h.
TImage ::ConstWeakPointer itk::ImageConstIterator< TImage >::m_Image [protected, inherited] |
Definition at line 377 of file itkImageConstIterator.h.
unsigned long itk::ImageConstIterator< TImage >::m_Offset [protected, inherited] |
Definition at line 380 of file itkImageConstIterator.h.
AccessorType itk::ImageConstIterator< TImage >::m_PixelAccessor [protected, inherited] |
Definition at line 386 of file itkImageConstIterator.h.
AccessorFunctorType itk::ImageConstIterator< TImage >::m_PixelAccessorFunctor [protected, inherited] |
Definition at line 387 of file itkImageConstIterator.h.
RegionType itk::ImageConstIterator< TImage >::m_Region [protected, inherited] |
Definition at line 378 of file itkImageConstIterator.h.
The documentation for this class was generated from the following file:
