ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageLinearConstIteratorWithIndex.h>
A multi-dimensional image iterator that visits image pixels within a region in a "scan-line" order.
ImageLinearConstIteratorWithIndex is templated over image type and is constrained to walk within a specified image region. It is designed for line-by-line processing of images. This iterator walks a linear path along a selected image direction that is parallel to one of the coordinate axes of the image. The iterator conceptually breaks the image into a set of parallel lines that span the selected image dimension.
ImageLinearConstIteratorWithIndex assumes a particular layout of the image data. The is arranged in a 1D array as if it were [][][][slice][row][col] with Index[0] = col, Index[1] = row, Index[2] = slice, etc.
operator++ provides a simple syntax for walking around a region of a multidimensional image. operator++ iterates across a preselected direction constraining the movement to within a region of image. The user can verify when the iterator reaches the boundary of the region along this direction, by calling the IsAtEndOfLine() method. Then it is possible to pass to the next line starting at the first pixel in the row that is part of the region by calling the NextLine() method.
This is the typical use of this iterator in a loop:
Definition at line 103 of file itkImageLinearConstIteratorWithIndex.h.
Public Types | |
typedef TImage | ImageType |
typedef TImage::IndexType | IndexType |
typedef TImage::PixelContainer | PixelContainer |
typedef PixelContainer::Pointer | PixelContainerPointer |
typedef TImage::RegionType | RegionType |
typedef ImageLinearConstIteratorWithIndex | Self |
typedef ImageConstIteratorWithIndex < TImage > | Superclass |
Public Types inherited from itk::ImageConstIteratorWithIndex< TImage > | |
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 ImageConstIteratorWithIndex | Self |
typedef TImage::SizeType | SizeType |
typedef SizeType::SizeValueType | SizeValueType |
Private Attributes | |
unsigned int | m_Direction |
OffsetValueType | m_Jump |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage > | |
static unsigned int | GetImageDimension () |
Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage > | |
static const unsigned int | ImageDimension = TImage::ImageDimension |
Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage > | |
const InternalPixelType * | m_Begin |
IndexType | m_BeginIndex |
const InternalPixelType * | m_End |
IndexType | m_EndIndex |
TImage::ConstWeakPointer | m_Image |
OffsetValueType | 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 itk::ImageLinearConstIteratorWithIndex< 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 so that it is not confused with ImageIterator::Index.
Definition at line 126 of file itkImageLinearConstIteratorWithIndex.h.
typedef TImage::IndexType itk::ImageLinearConstIteratorWithIndex< 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 so that it is not confused with ImageIterator::Index.
Definition at line 114 of file itkImageLinearConstIteratorWithIndex.h.
typedef TImage::PixelContainer itk::ImageLinearConstIteratorWithIndex< 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.
Definition at line 131 of file itkImageLinearConstIteratorWithIndex.h.
typedef PixelContainer::Pointer itk::ImageLinearConstIteratorWithIndex< TImage >::PixelContainerPointer |
Definition at line 132 of file itkImageLinearConstIteratorWithIndex.h.
typedef TImage::RegionType itk::ImageLinearConstIteratorWithIndex< 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 it is not confused with ImageIterator::Index.
Definition at line 120 of file itkImageLinearConstIteratorWithIndex.h.
typedef ImageLinearConstIteratorWithIndex itk::ImageLinearConstIteratorWithIndex< TImage >::Self |
Standard class typedefs.
Definition at line 107 of file itkImageLinearConstIteratorWithIndex.h.
typedef ImageConstIteratorWithIndex< TImage > itk::ImageLinearConstIteratorWithIndex< TImage >::Superclass |
Definition at line 108 of file itkImageLinearConstIteratorWithIndex.h.
|
inline |
Default constructor. Needed since we provide a cast constructor.
Definition at line 135 of file itkImageLinearConstIteratorWithIndex.h.
itk::ImageLinearConstIteratorWithIndex< TImage >::ImageLinearConstIteratorWithIndex | ( | const ImageType * | ptr, |
const RegionType & | region | ||
) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
|
inline |
Constructor that can be used to cast from an ImageIterator to an ImageLinearConstIteratorWithIndex. Many routines return an ImageIterator but for a particular task, you may want an ImageLinearConstIteratorWithIndex. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageLinearConstIteratorWithIndex.
Definition at line 147 of file itkImageLinearConstIteratorWithIndex.h.
|
inline |
get the direction of movement
Definition at line 196 of file itkImageLinearConstIteratorWithIndex.h.
void itk::ImageLinearConstIteratorWithIndex< TImage >::GoToBeginOfLine | ( | void | ) |
Go to the beginning pixel of the current line.
void itk::ImageLinearConstIteratorWithIndex< TImage >::GoToEndOfLine | ( | void | ) |
Go to the past end pixel of the current line.
void itk::ImageLinearConstIteratorWithIndex< TImage >::GoToReverseBeginOfLine | ( | void | ) |
Go to the beginning pixel of the current line.
|
inline |
Test if the index is at the end of line
Definition at line 171 of file itkImageLinearConstIteratorWithIndex.h.
|
inline |
Test if the index is at the begin of line
Definition at line 177 of file itkImageLinearConstIteratorWithIndex.h.
|
inline |
Go to the next line.
Definition at line 233 of file itkImageLinearConstIteratorWithIndex.h.
|
inline |
Increment (prefix) the selected dimension. No bounds checking is performed.
Definition at line 203 of file itkImageLinearConstIteratorWithIndex.h.
|
inline |
Decrement (prefix) the selected dimension. No bounds checking is performed.
Definition at line 213 of file itkImageLinearConstIteratorWithIndex.h.
|
inline |
Go to the previous line.
Definition at line 271 of file itkImageLinearConstIteratorWithIndex.h.
|
inline |
Set the direction of movement
Definition at line 183 of file itkImageLinearConstIteratorWithIndex.h.
|
private |
Definition at line 223 of file itkImageLinearConstIteratorWithIndex.h.
|
private |
Definition at line 222 of file itkImageLinearConstIteratorWithIndex.h.