ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkReflectiveImageRegionConstIterator.h>
Multi-dimensional image iterator which only walks a region.
ReflectiveImageRegionConstIterator is a templated class to represent a multi-dimensional iterator. ReflectiveImageRegionConstIterator is templated over the image type. ReflectiveImageRegionConstIterator is constrained to walk only within the specified region.
ReflectiveImageRegionConstIterator will perform two passes over the image along each dimension. It is useful for algorithms that require to go back and forth (once) over the data.
By setting the BeginOffset and EndOffset parameters, you can arrange for the starting point, when going forwards, to be different from the ending point, when going backwards. Along dimension d, when going forwards the iterator traverses the interval [BeginIndex[d]+BeginOffset[d], EndIndex[d]). When going back, it traverses the interval (EndIndex[d]-EndOffset[d], BeginIndex[d]]. Setting both offsets to (1, ..., 1) enables the DanielssonDistanceMapImageFilter to process the entire image, without encountering boundary conditions, rather than removing a one-pixel border.
Definition at line 53 of file itkReflectiveImageRegionConstIterator.h.
Public Types | |
typedef TImage | ImageType |
typedef TImage::IndexType | IndexType |
typedef TImage::OffsetType | OffsetType |
typedef OffsetType::OffsetValueType | OffsetValueType |
typedef TImage::PixelContainer | PixelContainer |
typedef PixelContainer::Pointer | PixelContainerPointer |
typedef TImage::RegionType | RegionType |
typedef ReflectiveImageRegionConstIterator | Self |
typedef TImage::SizeType | SizeType |
typedef TImage::SizeValueType | SizeValueType |
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 | |
OffsetType | m_BeginOffset |
OffsetType | m_EndOffset |
bool | m_IsFirstPass [TImage::ImageDimension] |
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::ReflectiveImageRegionConstIterator< 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.
Definition at line 70 of file itkReflectiveImageRegionConstIterator.h.
typedef TImage::IndexType itk::ReflectiveImageRegionConstIterator< 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.
Definition at line 64 of file itkReflectiveImageRegionConstIterator.h.
typedef TImage::OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::OffsetType |
Type of the Offset taken from the image. These typedefs are duplicated from the superclass for gcc support.
Definition at line 90 of file itkReflectiveImageRegionConstIterator.h.
typedef OffsetType::OffsetValueType itk::ReflectiveImageRegionConstIterator< TImage >::OffsetValueType |
Definition at line 91 of file itkReflectiveImageRegionConstIterator.h.
typedef TImage::PixelContainer itk::ReflectiveImageRegionConstIterator< 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 76 of file itkReflectiveImageRegionConstIterator.h.
typedef PixelContainer::Pointer itk::ReflectiveImageRegionConstIterator< TImage >::PixelContainerPointer |
Definition at line 77 of file itkReflectiveImageRegionConstIterator.h.
typedef TImage::RegionType itk::ReflectiveImageRegionConstIterator< 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.
Definition at line 84 of file itkReflectiveImageRegionConstIterator.h.
typedef ReflectiveImageRegionConstIterator itk::ReflectiveImageRegionConstIterator< TImage >::Self |
Standard class typedefs.
Definition at line 57 of file itkReflectiveImageRegionConstIterator.h.
typedef TImage::SizeType itk::ReflectiveImageRegionConstIterator< TImage >::SizeType |
Definition at line 85 of file itkReflectiveImageRegionConstIterator.h.
typedef TImage::SizeValueType itk::ReflectiveImageRegionConstIterator< TImage >::SizeValueType |
Definition at line 86 of file itkReflectiveImageRegionConstIterator.h.
typedef ImageConstIteratorWithIndex< TImage > itk::ReflectiveImageRegionConstIterator< TImage >::Superclass |
Definition at line 58 of file itkReflectiveImageRegionConstIterator.h.
itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator | ( | ) |
Default constructor. Needed since we provide a cast constructor.
|
inline |
Default destructor.
Definition at line 97 of file itkReflectiveImageRegionConstIterator.h.
itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator | ( | TImage * | ptr, |
const RegionType & | region | ||
) |
Constructor establishes an iterator to walk a particular image and a particular region of that image.
itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator | ( | const Self & | it | ) |
Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.
itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator | ( | const ImageConstIteratorWithIndex< TImage > & | it | ) |
Constructor that can be used to cast from an ImageIterator to an ReflectiveImageRegionConstIterator. Many routines return an ImageIterator but for a particular task, you may want an ReflectiveImageRegionConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from * an ImageIterator to a ReflectiveImageRegionConstIterator.
void itk::ReflectiveImageRegionConstIterator< TImage >::FillOffsets | ( | const OffsetValueType & | value | ) |
Fill both offsets with a single value.
|
inline |
Get the begin offset. Forward iteration starts at this offset from the current region.
Definition at line 152 of file itkReflectiveImageRegionConstIterator.h.
|
inline |
Get the end offset. Reverse iteration starts at this offset from the current region.
Definition at line 157 of file itkReflectiveImageRegionConstIterator.h.
void itk::ReflectiveImageRegionConstIterator< TImage >::GoToBegin | ( | void | ) |
Move an iterator to the beginning of the region.
|
inline |
Is the iterator at the beginning of the region?
Definition at line 135 of file itkReflectiveImageRegionConstIterator.h.
bool itk::ReflectiveImageRegionConstIterator< TImage >::IsReflected | ( | unsigned | int | ) | const |
Self& itk::ReflectiveImageRegionConstIterator< TImage >::operator++ | ( | ) |
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.
Self& itk::ReflectiveImageRegionConstIterator< TImage >::operator= | ( | const Self & | it | ) |
operator= is provided to make sure the handle to the image is properly reference counted.
|
inline |
Set the begin offset. Forward iteration starts at this offset from the current region.
Definition at line 142 of file itkReflectiveImageRegionConstIterator.h.
|
inline |
Set the end offset. Reverse iteration starts at this offset from the current region.
Definition at line 147 of file itkReflectiveImageRegionConstIterator.h.
|
private |
Definition at line 165 of file itkReflectiveImageRegionConstIterator.h.
|
private |
Definition at line 166 of file itkReflectiveImageRegionConstIterator.h.
|
private |
Definition at line 164 of file itkReflectiveImageRegionConstIterator.h.