ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Private Attributes | List of all members
itk::ReflectiveImageRegionConstIterator< TImage > Class Template Reference

#include <itkReflectiveImageRegionConstIterator.h>

+ Inheritance diagram for itk::ReflectiveImageRegionConstIterator< TImage >:
+ Collaboration diagram for itk::ReflectiveImageRegionConstIterator< TImage >:

Public Types

using ImageType = TImage
 
using IndexType = typename TImage::IndexType
 
using OffsetType = typename TImage::OffsetType
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using PixelContainer = typename TImage::PixelContainer
 
using PixelContainerPointer = typename PixelContainer::Pointer
 
using RegionType = typename TImage::RegionType
 
using Self = ReflectiveImageRegionConstIterator
 
using SizeType = typename TImage::SizeType
 
using SizeValueType = typename TImage::SizeValueType
 
using Superclass = ImageConstIteratorWithIndex< TImage >
 
- Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
using AccessorFunctorType = typename TImage::AccessorFunctorType
 
using AccessorType = typename TImage::AccessorType
 
using ImageType = TImage
 
using IndexType = typename TImage::IndexType
 
using IndexValueType = typename IndexType::IndexValueType
 
using InternalPixelType = typename TImage::InternalPixelType
 
using OffsetType = typename TImage::OffsetType
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using PixelContainer = typename TImage::PixelContainer
 
using PixelContainerPointer = typename PixelContainer::Pointer
 
using PixelType = typename TImage::PixelType
 
using RegionType = typename TImage::RegionType
 
using Self = ImageConstIteratorWithIndex
 
using SizeType = typename TImage::SizeType
 
using SizeValueType = typename SizeType::SizeValueType
 

Public Member Functions

void FillOffsets (const OffsetValueType &value)
 
OffsetType GetBeginOffset (const OffsetType &)
 
OffsetType GetEndOffset (const OffsetType &)
 
void GoToBegin ()
 
bool IsAtBegin () const
 
bool IsReflected (unsigned int) const
 
Selfoperator++ ()
 
Selfoperator= (const Self &it)
 
 ReflectiveImageRegionConstIterator ()
 
 ReflectiveImageRegionConstIterator (const ImageConstIteratorWithIndex< TImage > &it)
 
 ReflectiveImageRegionConstIterator (const Self &it)
 
 ReflectiveImageRegionConstIterator (TImage *ptr, const RegionType &region)
 
void SetBeginOffset (const OffsetType &offset)
 
void SetEndOffset (const OffsetType &offset)
 
 ~ReflectiveImageRegionConstIterator () override=default
 
- Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
const IndexTypeGetIndex () const
 
const RegionTypeGetRegion () const
 
 ImageConstIteratorWithIndex ()
 
 ImageConstIteratorWithIndex (const Self &it)
 
 ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
 
bool operator!= (const Self &it) const
 
bool operator< (const Self &it) const
 
bool operator<= (const Self &it) const
 
Selfoperator= (const Self &it)
 
bool operator== (const Self &it) const
 
bool operator> (const Self &it) const
 
bool operator>= (const Self &it) const
 
virtual ~ImageConstIteratorWithIndex ()=default
 
void SetIndex (const IndexType &ind)
 
PixelType Get () const
 
const PixelTypeValue () const
 
void GoToBegin ()
 
void GoToReverseBegin ()
 
bool IsAtReverseEnd () const
 
bool IsAtEnd () const
 
bool Remaining ()
 

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 constexpr unsigned int ImageDimension = TImage::ImageDimension
 
- Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
TImage::ConstWeakPointer m_Image
 
IndexType m_PositionIndex
 
IndexType m_BeginIndex
 
IndexType m_EndIndex
 
RegionType m_Region
 
OffsetValueType m_OffsetTable [ImageDimension+1]
 
const InternalPixelTypem_Position
 
const InternalPixelTypem_Begin
 
const InternalPixelTypem_End
 
bool m_Remaining
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 

Detailed Description

template<typename TImage>
class itk::ReflectiveImageRegionConstIterator< TImage >

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.

See also
DanielssonDistanceMapImageFilter

Definition at line 54 of file itkReflectiveImageRegionConstIterator.h.

Member Typedef Documentation

◆ ImageType

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::ImageType = TImage

Image type alias 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 72 of file itkReflectiveImageRegionConstIterator.h.

◆ IndexType

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::IndexType = typename TImage::IndexType

Index type alias 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 66 of file itkReflectiveImageRegionConstIterator.h.

◆ OffsetType

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::OffsetType = typename TImage::OffsetType

Type of the Offset taken from the image. These type alias are duplicated from the superclass for gcc support.

Definition at line 92 of file itkReflectiveImageRegionConstIterator.h.

◆ OffsetValueType

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 93 of file itkReflectiveImageRegionConstIterator.h.

◆ PixelContainer

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::PixelContainer = typename TImage::PixelContainer

PixelContainer type alias 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 78 of file itkReflectiveImageRegionConstIterator.h.

◆ PixelContainerPointer

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::PixelContainerPointer = typename PixelContainer::Pointer

Definition at line 79 of file itkReflectiveImageRegionConstIterator.h.

◆ RegionType

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::RegionType = typename TImage::RegionType

Region type alias 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 86 of file itkReflectiveImageRegionConstIterator.h.

◆ Self

Standard class type aliases.

Definition at line 59 of file itkReflectiveImageRegionConstIterator.h.

◆ SizeType

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::SizeType = typename TImage::SizeType

Definition at line 87 of file itkReflectiveImageRegionConstIterator.h.

◆ SizeValueType

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::SizeValueType = typename TImage::SizeValueType

Definition at line 88 of file itkReflectiveImageRegionConstIterator.h.

◆ Superclass

template<typename TImage>
using itk::ReflectiveImageRegionConstIterator< TImage >::Superclass = ImageConstIteratorWithIndex<TImage>

Definition at line 60 of file itkReflectiveImageRegionConstIterator.h.

Constructor & Destructor Documentation

◆ ReflectiveImageRegionConstIterator() [1/4]

Default constructor. Needed since we provide a cast constructor.

◆ ~ReflectiveImageRegionConstIterator()

template<typename TImage>
itk::ReflectiveImageRegionConstIterator< TImage >::~ReflectiveImageRegionConstIterator ( )
overridedefault

Default destructor.

◆ ReflectiveImageRegionConstIterator() [2/4]

template<typename TImage>
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.

◆ ReflectiveImageRegionConstIterator() [3/4]

template<typename TImage>
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.

◆ ReflectiveImageRegionConstIterator() [4/4]

template<typename TImage>
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.

Member Function Documentation

◆ FillOffsets()

template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::FillOffsets ( const OffsetValueType value)

Fill both offsets with a single value.

◆ GetBeginOffset()

template<typename TImage>
OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::GetBeginOffset ( const OffsetType )
inline

Get the begin offset. Forward iteration starts at this offset from the current region.

Definition at line 166 of file itkReflectiveImageRegionConstIterator.h.

◆ GetEndOffset()

template<typename TImage>
OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::GetEndOffset ( const OffsetType )
inline

Get the end offset. Reverse iteration starts at this offset from the current region.

Definition at line 174 of file itkReflectiveImageRegionConstIterator.h.

◆ GoToBegin()

template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::GoToBegin ( )

Move an iterator to the beginning of the region.

◆ IsAtBegin()

template<typename TImage>
bool itk::ReflectiveImageRegionConstIterator< TImage >::IsAtBegin ( ) const
inline

Is the iterator at the beginning of the region?

Definition at line 142 of file itkReflectiveImageRegionConstIterator.h.

◆ IsReflected()

template<typename TImage>
bool itk::ReflectiveImageRegionConstIterator< TImage >::IsReflected ( unsigned int  ) const

◆ operator++()

template<typename TImage>
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.

See also
operator++(int)

◆ operator=()

template<typename TImage>
Self& itk::ReflectiveImageRegionConstIterator< TImage >::operator= ( const Self it)

operator= is provided to make sure the handle to the image is properly reference counted.

◆ SetBeginOffset()

template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::SetBeginOffset ( const OffsetType offset)
inline

Set the begin offset. Forward iteration starts at this offset from the current region.

Definition at line 150 of file itkReflectiveImageRegionConstIterator.h.

◆ SetEndOffset()

template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::SetEndOffset ( const OffsetType offset)
inline

Set the end offset. Reverse iteration starts at this offset from the current region.

Definition at line 158 of file itkReflectiveImageRegionConstIterator.h.

Member Data Documentation

◆ m_BeginOffset

template<typename TImage>
OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::m_BeginOffset
private

Definition at line 185 of file itkReflectiveImageRegionConstIterator.h.

◆ m_EndOffset

template<typename TImage>
OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::m_EndOffset
private

Definition at line 186 of file itkReflectiveImageRegionConstIterator.h.

◆ m_IsFirstPass

template<typename TImage>
bool itk::ReflectiveImageRegionConstIterator< TImage >::m_IsFirstPass[TImage::ImageDimension]
private

Definition at line 184 of file itkReflectiveImageRegionConstIterator.h.


The documentation for this class was generated from the following file: