Multi-dimensional image iterator which only walks a region. More...
#include <itkReflectiveImageRegionIterator.h>
Detailed Description
template<typename TImage>
class itk::ReflectiveImageRegionIterator< TImage >
Multi-dimensional image iterator which only walks a region.
ReflectiveImageRegionIterator is a templated class to represent a multi-dimensional iterator. ReflectiveImageRegionIterator is templated over the image type ReflectiveImageRegionIterator is constrained to walk only within the specified region and along a line parallel to one of the coordinate axis.
Most of the functionality is inherited from the ReflectiveImageRegionConstIterator. The current class only adds write access to image pixels.
- See also:
- ReflectiveImageRegionConstIterator
Definition at line 45 of file itkReflectiveImageRegionIterator.h.
Member Typedef Documentation
typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType [inherited] |
Definition at line 132 of file itkImageConstIteratorWithIndex.h.
| typedef Superclass::AccessorType itk::ReflectiveImageRegionIterator< TImage >::AccessorType |
Accessor type that convert data between internal and external representations.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 65 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::ImageType itk::ReflectiveImageRegionIterator< 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::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 60 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::IndexType itk::ReflectiveImageRegionIterator< TImage >::IndexType |
Types inherited from the Superclass
Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 53 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::IndexValueType itk::ReflectiveImageRegionIterator< TImage >::IndexValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 54 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::InternalPixelType itk::ReflectiveImageRegionIterator< TImage >::InternalPixelType |
Internal Pixel Type
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 63 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::OffsetType itk::ReflectiveImageRegionIterator< TImage >::OffsetType |
Type of the Offset taken from the image. These typedefs are duplicated from the superclass for gcc support.
Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 57 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::OffsetValueType itk::ReflectiveImageRegionIterator< TImage >::OffsetValueType |
Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 58 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::PixelContainer itk::ReflectiveImageRegionIterator< 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::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 61 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::PixelContainerPointer itk::ReflectiveImageRegionIterator< TImage >::PixelContainerPointer |
Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 62 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::PixelType itk::ReflectiveImageRegionIterator< TImage >::PixelType |
External Pixel Type
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 64 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::RegionType itk::ReflectiveImageRegionIterator< 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::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 59 of file itkReflectiveImageRegionIterator.h.
| typedef ReflectiveImageRegionIterator itk::ReflectiveImageRegionIterator< TImage >::Self |
Standard class typedefs.
Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 49 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::SizeType itk::ReflectiveImageRegionIterator< TImage >::SizeType |
Size typedef support.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 55 of file itkReflectiveImageRegionIterator.h.
| typedef Superclass::SizeValueType itk::ReflectiveImageRegionIterator< TImage >::SizeValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 56 of file itkReflectiveImageRegionIterator.h.
| typedef ReflectiveImageRegionConstIterator<TImage> itk::ReflectiveImageRegionIterator< TImage >::Superclass |
Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.
Definition at line 50 of file itkReflectiveImageRegionIterator.h.
Constructor & Destructor Documentation
| itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator | ( | ) |
Default constructor. Needed since we provide a cast constructor.
| itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator | ( | ImageType * | ptr, | |
| const RegionType & | region | |||
| ) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
| itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator | ( | const ImageIteratorWithIndex< TImage > & | it | ) |
Constructor that can be used to cast from an ImageIterator to an ReflectiveImageRegionIterator. Many routines return an ImageIterator but for a particular task, you may want an ReflectiveImageRegionIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ReflectiveImageRegionIterator.
| itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator | ( | const ReflectiveImageRegionConstIterator< 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
| void itk::ReflectiveImageRegionConstIterator< TImage >::FillOffsets | ( | const OffsetValueType & | value | ) | [inherited] |
Fill both offsets with a single value.
| PixelType itk::ImageConstIteratorWithIndex< TImage >::Get | ( | void | ) | const [inline, inherited] |
Get the pixel value
Definition at line 237 of file itkImageConstIteratorWithIndex.h.
| OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::GetBeginOffset | ( | const OffsetType & | offset | ) | [inline, inherited] |
Get the begin offset. Forward iteration starts at this offset from the current region.
Definition at line 150 of file itkReflectiveImageRegionConstIterator.h.
| OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::GetEndOffset | ( | const OffsetType & | offset | ) | [inline, inherited] |
Get the end offset. Reverse iteration starts at this offset from the current region.
Definition at line 155 of file itkReflectiveImageRegionConstIterator.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::ReflectiveImageRegionConstIterator< TImage >::GoToBegin | ( | void | ) | [inherited] |
Move an iterator to the beginning of the region.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
| void itk::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin | ( | void | ) | [inherited] |
Move an iterator to the End of the region.
| bool itk::ReflectiveImageRegionConstIterator< TImage >::IsAtBegin | ( | void | ) | const [inline, inherited] |
Is the iterator at the beginning of the region?
Definition at line 133 of file itkReflectiveImageRegionConstIterator.h.
| 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::ReflectiveImageRegionConstIterator< TImage >::IsReflected | ( | unsigned | int | ) | const [inherited] |
| 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::ReflectiveImageRegionConstIterator< 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++(int)
| 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::ReflectiveImageRegionIterator< TImage >::operator= | ( | const ReflectiveImageRegionConstIterator< 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::ReflectiveImageRegionIterator< TImage >::Set | ( | const PixelType & | value | ) | const [inline] |
Set the pixel value
Definition at line 84 of file itkReflectiveImageRegionIterator.h.
| void itk::ReflectiveImageRegionConstIterator< TImage >::SetBeginOffset | ( | const OffsetType & | offset | ) | [inline, inherited] |
Set the begin offset. Forward iteration starts at this offset from the current region.
Definition at line 140 of file itkReflectiveImageRegionConstIterator.h.
| void itk::ReflectiveImageRegionConstIterator< TImage >::SetEndOffset | ( | const OffsetType & | offset | ) | [inline, inherited] |
Set the end offset. Reverse iteration starts at this offset from the current region.
Definition at line 145 of file itkReflectiveImageRegionConstIterator.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.
| PixelType& itk::ReflectiveImageRegionIterator< 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 90 of file itkReflectiveImageRegionIterator.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.
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 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:
