itk::ImageSliceIteratorWithIndex< TImage > Class Template Reference
[Image Iterators]
#include <itkImageSliceIteratorWithIndex.h>
Detailed Description
template<typename TImage>
class itk::ImageSliceIteratorWithIndex< TImage >
A multi-dimensional image iterator that extends the ImageLinearIteratorWithIndex from iteration along lines in an image to iteration along both lines and planes (slices) within an image. A slice is defined as a 2D plane spanned by two vectors pointing along orthogonal coordinate axes.
Most of the functionality is inherited from the ImageSliceConstIteratorWithIndex. The current class only adds write access to image pixels. See ImageSliceConstIteratorWithIndex for details.
- 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:
Definition at line 68 of file itkImageSliceIteratorWithIndex.h.
Member Typedef Documentation
typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType [inherited] |
Definition at line 132 of file itkImageConstIteratorWithIndex.h.
| typedef Superclass::AccessorType itk::ImageSliceIteratorWithIndex< TImage >::AccessorType |
Accessor type that convert data between internal and external representations.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 88 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::ImageType itk::ImageSliceIteratorWithIndex< 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 Index back to itk::Index to that is it not confused with ImageIterator::Index.
Reimplemented from itk::ImageSliceConstIteratorWithIndex< TImage >.
Definition at line 83 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::IndexType itk::ImageSliceIteratorWithIndex< TImage >::IndexType |
Types inherited from the Superclass
Reimplemented from itk::ImageSliceConstIteratorWithIndex< TImage >.
Definition at line 76 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::IndexValueType itk::ImageSliceIteratorWithIndex< TImage >::IndexValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 77 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::InternalPixelType itk::ImageSliceIteratorWithIndex< TImage >::InternalPixelType |
Internal Pixel Type
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 86 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::OffsetType itk::ImageSliceIteratorWithIndex< TImage >::OffsetType |
Type of the Offset taken from the image
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 80 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::OffsetValueType itk::ImageSliceIteratorWithIndex< TImage >::OffsetValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 81 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::PixelContainer itk::ImageSliceIteratorWithIndex< 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::ImageSliceConstIteratorWithIndex< TImage >.
Definition at line 84 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::PixelContainerPointer itk::ImageSliceIteratorWithIndex< TImage >::PixelContainerPointer |
Reimplemented from itk::ImageSliceConstIteratorWithIndex< TImage >.
Definition at line 85 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::PixelType itk::ImageSliceIteratorWithIndex< TImage >::PixelType |
External Pixel Type
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 87 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::RegionType itk::ImageSliceIteratorWithIndex< TImage >::RegionType |
Region typedef support.
Reimplemented from itk::ImageSliceConstIteratorWithIndex< TImage >.
Definition at line 82 of file itkImageSliceIteratorWithIndex.h.
| typedef ImageSliceIteratorWithIndex itk::ImageSliceIteratorWithIndex< TImage >::Self |
Standard class typedefs.
Reimplemented from itk::ImageSliceConstIteratorWithIndex< TImage >.
Definition at line 72 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::SizeType itk::ImageSliceIteratorWithIndex< TImage >::SizeType |
Size typedef support.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 78 of file itkImageSliceIteratorWithIndex.h.
| typedef Superclass::SizeValueType itk::ImageSliceIteratorWithIndex< TImage >::SizeValueType |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Definition at line 79 of file itkImageSliceIteratorWithIndex.h.
| typedef ImageSliceConstIteratorWithIndex<TImage> itk::ImageSliceIteratorWithIndex< TImage >::Superclass |
Reimplemented from itk::ImageSliceConstIteratorWithIndex< TImage >.
Definition at line 73 of file itkImageSliceIteratorWithIndex.h.
Constructor & Destructor Documentation
| itk::ImageSliceIteratorWithIndex< TImage >::ImageSliceIteratorWithIndex | ( | ) |
Default constructor. Needed since we provide a cast constructor.
| itk::ImageSliceIteratorWithIndex< TImage >::ImageSliceIteratorWithIndex | ( | ImageType * | ptr, | |
| const RegionType & | region | |||
| ) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
| itk::ImageSliceIteratorWithIndex< TImage >::ImageSliceIteratorWithIndex | ( | const ImageIteratorWithIndex< TImage > & | it | ) |
Constructor that can be used to cast from an ImageIterator to an ImageSliceIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageSliceIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageSliceIteratorWithIndex.
| itk::ImageSliceIteratorWithIndex< TImage >::ImageSliceIteratorWithIndex | ( | const ImageSliceConstIteratorWithIndex< 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::ImageSliceConstIteratorWithIndex< TImage >::IsAtEndOfLine | ( | void | ) | [inherited] |
Test if the index is at the end of line
| bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtEndOfSlice | ( | void | ) | [inherited] |
Test if the index is at the end of the slice
| 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::ImageSliceConstIteratorWithIndex< TImage >::IsAtReverseEndOfLine | ( | void | ) | [inherited] |
Test if the index is at the begin of line
| bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtReverseEndOfSlice | ( | void | ) | [inherited] |
Test if the index is at the begin of the slice
| 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.
| void itk::ImageSliceConstIteratorWithIndex< TImage >::NextLine | ( | void | ) | [inherited] |
| void itk::ImageSliceConstIteratorWithIndex< TImage >::NextSlice | ( | void | ) | [inherited] |
Go to the next slice
- See also:
- operator++
EndOfLine
| 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::ImageSliceConstIteratorWithIndex< TImage >::operator++ | ( | ) | [inline, inherited] |
Increment (prefix) the selected dimension. No bounds checking is performed.
- See also:
- operator--
| Self& itk::ImageSliceConstIteratorWithIndex< TImage >::operator-- | ( | ) | [inline, inherited] |
Decrement (prefix) the selected dimension. No bounds checking is performed.
- 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::ImageSliceIteratorWithIndex< TImage >::operator= | ( | const ImageSliceConstIteratorWithIndex< 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.
| void itk::ImageSliceConstIteratorWithIndex< TImage >::PreviousLine | ( | void | ) | [inherited] |
Go to the next line
- See also:
- operator--
BeginOfLine
BeginOfSlice
| void itk::ImageSliceConstIteratorWithIndex< TImage >::PreviousSlice | ( | void | ) | [inherited] |
Go to the next slice
- See also:
- operator--
BeginOfLine
BeginOfSlice
| bool itk::ImageConstIteratorWithIndex< TImage >::Remaining | ( | ) | [inline, inherited] |
Are there data remainning in the region ?
Definition at line 273 of file itkImageConstIteratorWithIndex.h.
| void itk::ImageSliceIteratorWithIndex< TImage >::Set | ( | const PixelType & | value | ) | const [inline] |
Set the pixel value
Definition at line 107 of file itkImageSliceIteratorWithIndex.h.
| void itk::ImageSliceConstIteratorWithIndex< TImage >::SetFirstDirection | ( | unsigned int | direction | ) | [inherited] |
Set the fastest direction of movement
| 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.
| void itk::ImageSliceConstIteratorWithIndex< TImage >::SetSecondDirection | ( | unsigned int | direction | ) | [inherited] |
Set the second fastest direction of movement
| 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::ImageSliceIteratorWithIndex< 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 113 of file itkImageSliceIteratorWithIndex.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:
