#include <itkImageSliceConstIteratorWithIndex.h>
Inheritance diagram for itk::ImageSliceConstIteratorWithIndex< TImage >:
where n is the number of the axis.
Use the following methods to move the iterator between slices:
To test the position of the iterator with respect to the end or beginning of the slice use the following methods:
The following code, for example, illustrates the typical use of this iterator. For more information please see the Software Guide.
ImageSliceConstIteratorWithIndex<ImageType> it( image, image->GetRequestedRegion() ); it.SetFirstDirection(2); it.SetSecondDirection(0); it.GoToBegin(); while( !it.IsAtEnd() ) { while( !it.IsAtEndOfSlice() ) { while( !it.IsAtEndOfLine() ) { value = it.Get(); // it.Set() doesn't exist in the Const Iterator ++it; } it.NextLine(); } it.NextSlice(); }
Definition at line 112 of file itkImageSliceConstIteratorWithIndex.h.
Public Types | |
typedef TImage::AccessorFunctorType | AccessorFunctorType |
typedef TImage::AccessorType | AccessorType |
typedef TImage | ImageType |
typedef TImage::IndexType | IndexType |
typedef IndexType::IndexValueType | IndexValueType |
typedef TImage::InternalPixelType | InternalPixelType |
typedef TImage::OffsetType | OffsetType |
typedef OffsetType::OffsetValueType | OffsetValueType |
typedef TImage::PixelContainer | PixelContainer |
typedef PixelContainer::Pointer | PixelContainerPointer |
typedef TImage::PixelType | PixelType |
typedef TImage::RegionType | RegionType |
typedef ImageSliceConstIteratorWithIndex | Self |
typedef TImage::SizeType | SizeType |
typedef SizeType::SizeValueType | SizeValueType |
typedef ImageConstIteratorWithIndex< TImage > | Superclass |
Public Member Functions | |
Self | Begin (void) const |
Self | End (void) const |
PixelType | Get (void) const |
const IndexType & | GetIndex () const |
const RegionType & | GetRegion () const |
void | GoToBegin (void) |
void | GoToReverseBegin (void) |
ImageSliceConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it) | |
ImageSliceConstIteratorWithIndex () | |
bool | IsAtEnd (void) const |
bool | IsAtEndOfLine (void) |
bool | IsAtEndOfSlice (void) |
bool | IsAtReverseEnd (void) const |
bool | IsAtReverseEndOfLine (void) |
bool | IsAtReverseEndOfSlice (void) |
itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension) | |
void | NextLine (void) |
void | NextSlice (void) |
bool | operator!= (const Self &it) const |
Self & | operator++ () |
Self & | operator-- () |
bool | operator< (const Self &it) const |
bool | operator<= (const Self &it) const |
bool | operator== (const Self &it) const |
bool | operator> (const Self &it) const |
bool | operator>= (const Self &it) const |
void | PreviousLine (void) |
void | PreviousSlice (void) |
bool | Remaining () |
void | SetFirstDirection (unsigned int direction) |
void | SetSecondDirection (unsigned int direction) |
const PixelType & | Value (void) const |
void | SetIndex (const IndexType &ind) |
Static Public Member Functions | |
static unsigned int | GetImageDimension () |
Protected Attributes | |
const InternalPixelType * | m_Begin |
IndexType | m_BeginIndex |
const InternalPixelType * | m_End |
IndexType | m_EndIndex |
TImage::ConstWeakPointer | m_Image |
unsigned long | m_OffsetTable [ImageDimension+1] |
AccessorType | m_PixelAccessor |
AccessorFunctorType | m_PixelAccessorFunctor |
const InternalPixelType * | m_Position |
IndexType | m_PositionIndex |
RegionType | m_Region |
bool | m_Remaining |
typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType [inherited] |
Definition at line 132 of file itkImageConstIteratorWithIndex.h.
typedef TImage::AccessorType itk::ImageConstIteratorWithIndex< TImage >::AccessorType [inherited] |
Accessor type that convert data between internal and external representations.
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 131 of file itkImageConstIteratorWithIndex.h.
typedef TImage itk::ImageSliceConstIteratorWithIndex< 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::ImageConstIteratorWithIndex< TImage >.
Reimplemented in itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 129 of file itkImageSliceConstIteratorWithIndex.h.
typedef TImage::IndexType itk::ImageSliceConstIteratorWithIndex< TImage >::IndexType |
Index 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::ImageConstIteratorWithIndex< TImage >.
Reimplemented in itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 123 of file itkImageSliceConstIteratorWithIndex.h.
typedef IndexType::IndexValueType itk::ImageConstIteratorWithIndex< TImage >::IndexValueType [inherited] |
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 105 of file itkImageConstIteratorWithIndex.h.
typedef TImage::InternalPixelType itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType [inherited] |
Internal Pixel Type
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 124 of file itkImageConstIteratorWithIndex.h.
typedef TImage::OffsetType itk::ImageConstIteratorWithIndex< TImage >::OffsetType [inherited] |
Type of the Offset taken from the image
Reimplemented in itk::ReflectiveImageRegionConstIterator< TImage >, itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 135 of file itkImageConstIteratorWithIndex.h.
typedef OffsetType::OffsetValueType itk::ImageConstIteratorWithIndex< TImage >::OffsetValueType [inherited] |
Reimplemented in itk::ReflectiveImageRegionConstIterator< TImage >, itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 136 of file itkImageConstIteratorWithIndex.h.
typedef TImage::PixelContainer itk::ImageSliceConstIteratorWithIndex< 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 >.
Reimplemented in itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 137 of file itkImageSliceConstIteratorWithIndex.h.
typedef PixelContainer::Pointer itk::ImageSliceConstIteratorWithIndex< TImage >::PixelContainerPointer |
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Reimplemented in itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 138 of file itkImageSliceConstIteratorWithIndex.h.
typedef TImage::PixelType itk::ImageConstIteratorWithIndex< TImage >::PixelType [inherited] |
External Pixel Type
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 127 of file itkImageConstIteratorWithIndex.h.
typedef TImage::RegionType itk::ImageSliceConstIteratorWithIndex< TImage >::RegionType |
Region typedef support.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Reimplemented in itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 132 of file itkImageSliceConstIteratorWithIndex.h.
typedef ImageSliceConstIteratorWithIndex itk::ImageSliceConstIteratorWithIndex< TImage >::Self |
Standard class typedefs.
Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.
Reimplemented in itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 116 of file itkImageSliceConstIteratorWithIndex.h.
typedef TImage::SizeType itk::ImageConstIteratorWithIndex< TImage >::SizeType [inherited] |
Size typedef support.
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionConstIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 108 of file itkImageConstIteratorWithIndex.h.
typedef SizeType::SizeValueType itk::ImageConstIteratorWithIndex< TImage >::SizeValueType [inherited] |
Reimplemented in itk::ReflectiveImageRegionIterator< TImage >, itk::ImageIteratorWithIndex< TImage >, itk::ImageLinearIteratorWithIndex< TImage >, itk::ImageRandomIteratorWithIndex< TImage >, itk::ImageRandomNonRepeatingIteratorWithIndex< TImage >, itk::ImageRegionExclusionIteratorWithIndex< TImage >, itk::ImageRegionIteratorWithIndex< TImage >, and itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 109 of file itkImageConstIteratorWithIndex.h.
typedef ImageConstIteratorWithIndex<TImage> itk::ImageSliceConstIteratorWithIndex< TImage >::Superclass |
Reimplemented in itk::ImageSliceIteratorWithIndex< TImage >.
Definition at line 117 of file itkImageSliceConstIteratorWithIndex.h.
itk::ImageSliceConstIteratorWithIndex< TImage >::ImageSliceConstIteratorWithIndex | ( | ) | [inline] |
Default constructor. Needed since we provide a cast constructor.
Definition at line 141 of file itkImageSliceConstIteratorWithIndex.h.
itk::ImageSliceConstIteratorWithIndex< TImage >::ImageSliceConstIteratorWithIndex | ( | const ImageType * | ptr, | |
const RegionType & | region | |||
) | [inline] |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
Definition at line 145 of file itkImageSliceConstIteratorWithIndex.h.
itk::ImageSliceConstIteratorWithIndex< TImage >::ImageSliceConstIteratorWithIndex | ( | const ImageConstIteratorWithIndex< TImage > & | it | ) | [inline] |
Constructor that can be used to cast from an ImageIterator to an ImageSliceConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageSliceConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageSliceConstIteratorWithIndex.
Definition at line 160 of file itkImageSliceConstIteratorWithIndex.h.
itk::ImageSliceConstIteratorWithIndex< TImage >::ImageSliceConstIteratorWithIndex | ( | const ImageType * | ptr, | |
const RegionType & | region | |||
) | [inline] |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
Definition at line 145 of file itkImageSliceConstIteratorWithIndex.h.
Self itk::ImageConstIteratorWithIndex< TImage >::Begin | ( | void | ) | const [inherited] |
Move an iterator to the beginning of the region.
Self itk::ImageConstIteratorWithIndex< TImage >::End | ( | void | ) | const [inherited] |
Move an iterator to the End of the region.
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.
Definition at line 219 of file itkImageConstIteratorWithIndex.h.
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 >.
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.
bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtEndOfLine | ( | void | ) |
Test if the index is at the end of line
bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtEndOfSlice | ( | void | ) |
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 | ) |
Test if the index is at the begin of line
bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtReverseEndOfSlice | ( | void | ) |
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 | ) |
Go to the next line
EndOfLine
void itk::ImageSliceConstIteratorWithIndex< TImage >::NextSlice | ( | void | ) |
Go to the next slice
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.
References itk::ImageConstIteratorWithIndex< TImage >::m_Position.
Self& itk::ImageSliceConstIteratorWithIndex< TImage >::operator++ | ( | ) | [inline] |
Increment (prefix) the selected dimension. No bounds checking is performed.
Self& itk::ImageSliceConstIteratorWithIndex< TImage >::operator-- | ( | ) | [inline] |
Decrement (prefix) the selected dimension. No bounds checking is performed.
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.
References itk::ImageConstIteratorWithIndex< TImage >::m_Position.
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.
References itk::ImageConstIteratorWithIndex< TImage >::m_Position.
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.
References itk::ImageConstIteratorWithIndex< TImage >::m_Position.
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.
References itk::ImageConstIteratorWithIndex< TImage >::m_Position.
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.
References itk::ImageConstIteratorWithIndex< TImage >::m_Position.
void itk::ImageSliceConstIteratorWithIndex< TImage >::PreviousLine | ( | void | ) |
Go to the next line
BeginOfLine
BeginOfSlice
void itk::ImageSliceConstIteratorWithIndex< TImage >::PreviousSlice | ( | void | ) |
Go to the next slice
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::ImageSliceConstIteratorWithIndex< TImage >::SetFirstDirection | ( | unsigned int | direction | ) |
Set the fastest direction of movement
void itk::ImageConstIteratorWithIndex< TImage >::SetIndex | ( | const IndexType & | ind | ) | [inline, inherited] |
Set the index. No bounds checking is performed.
Definition at line 229 of file itkImageConstIteratorWithIndex.h.
void itk::ImageSliceConstIteratorWithIndex< TImage >::SetSecondDirection | ( | unsigned int | direction | ) |
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.
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< TImage >::operator!=(), itk::ImageConstIteratorWithIndex< TImage >::operator<(), itk::ImageConstIteratorWithIndex< TImage >::operator<=(), itk::ImageConstIteratorWithIndex< TImage >::operator==(), itk::ImageConstIteratorWithIndex< TImage >::operator>(), and itk::ImageConstIteratorWithIndex< TImage >::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.