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

#include <itkReflectiveImageRegionIterator.h>

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

Public Types

using AccessorType = typename Superclass::AccessorType
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename Superclass::IndexType
 
using IndexValueType = typename Superclass::IndexValueType
 
using InternalPixelType = typename Superclass::InternalPixelType
 
using OffsetType = typename Superclass::OffsetType
 
using OffsetValueType = typename Superclass::OffsetValueType
 
using PixelContainer = typename Superclass::PixelContainer
 
using PixelContainerPointer = typename Superclass::PixelContainerPointer
 
using PixelType = typename Superclass::PixelType
 
using RegionType = typename Superclass::RegionType
 
using Self = ReflectiveImageRegionIterator
 
using SizeType = typename Superclass::SizeType
 
using SizeValueType = typename Superclass::SizeValueType
 
using Superclass = ReflectiveImageRegionConstIterator< TImage >
 
- Public Types inherited from itk::ReflectiveImageRegionConstIterator< TImage >
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

 ReflectiveImageRegionIterator ()
 
 ReflectiveImageRegionIterator (const ImageIteratorWithIndex< TImage > &it)
 
 ReflectiveImageRegionIterator (ImageType *ptr, const RegionType &region)
 
void Set (const PixelType &value) const
 
PixelTypeValue ()
 
- Public Member Functions inherited from itk::ReflectiveImageRegionConstIterator< TImage >
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 ()
 

Protected Member Functions

 ReflectiveImageRegionIterator (const ReflectiveImageRegionConstIterator< TImage > &it)
 
Selfoperator= (const ReflectiveImageRegionConstIterator< TImage > &it)
 

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::ReflectiveImageRegionIterator< TImage >

Multi-dimensional image iterator which only walks a region.

ReflectiveImageRegionIterator is a templated class to represent a multi-dimensional iterator. ReflectiveImageRegionIterator is templated over the image type ReflectiveImageRegionIterator is constrained to walk only within the specified region and along a line parallel to one of the coordinate axis.

Most of the functionality is inherited from the ReflectiveImageRegionConstIterator. The current class only adds write access to image pixels.

See also
ReflectiveImageRegionConstIterator

Definition at line 45 of file itkReflectiveImageRegionIterator.h.

Member Typedef Documentation

◆ AccessorType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 66 of file itkReflectiveImageRegionIterator.h.

◆ ImageType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::ImageType = typename Superclass::ImageType

Definition at line 61 of file itkReflectiveImageRegionIterator.h.

◆ IndexType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::IndexType = typename Superclass::IndexType

Types inherited from the Superclass

Definition at line 54 of file itkReflectiveImageRegionIterator.h.

◆ IndexValueType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::IndexValueType = typename Superclass::IndexValueType

Definition at line 55 of file itkReflectiveImageRegionIterator.h.

◆ InternalPixelType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 64 of file itkReflectiveImageRegionIterator.h.

◆ OffsetType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 58 of file itkReflectiveImageRegionIterator.h.

◆ OffsetValueType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::OffsetValueType = typename Superclass::OffsetValueType

Definition at line 59 of file itkReflectiveImageRegionIterator.h.

◆ PixelContainer

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 62 of file itkReflectiveImageRegionIterator.h.

◆ PixelContainerPointer

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 63 of file itkReflectiveImageRegionIterator.h.

◆ PixelType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::PixelType = typename Superclass::PixelType

Definition at line 65 of file itkReflectiveImageRegionIterator.h.

◆ RegionType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::RegionType = typename Superclass::RegionType

Definition at line 60 of file itkReflectiveImageRegionIterator.h.

◆ Self

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::Self = ReflectiveImageRegionIterator

Standard class type aliases.

Definition at line 50 of file itkReflectiveImageRegionIterator.h.

◆ SizeType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::SizeType = typename Superclass::SizeType

Definition at line 56 of file itkReflectiveImageRegionIterator.h.

◆ SizeValueType

template<typename TImage >
using itk::ReflectiveImageRegionIterator< TImage >::SizeValueType = typename Superclass::SizeValueType

Definition at line 57 of file itkReflectiveImageRegionIterator.h.

◆ Superclass

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

Definition at line 51 of file itkReflectiveImageRegionIterator.h.

Constructor & Destructor Documentation

◆ ReflectiveImageRegionIterator() [1/4]

template<typename TImage >
itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( )

Default constructor. Needed since we provide a cast constructor.

◆ ReflectiveImageRegionIterator() [2/4]

template<typename TImage >
itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( ImageType ptr,
const RegionType region 
)

Constructor establishes an iterator to walk a particular image and a particular region of that image.

◆ ReflectiveImageRegionIterator() [3/4]

template<typename TImage >
itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( const ImageIteratorWithIndex< TImage > &  it)

Constructor that can be used to cast from an ImageIterator to an ReflectiveImageRegionIterator. Many routines return an ImageIterator but for a particular task, you may want an ReflectiveImageRegionIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ReflectiveImageRegionIterator.

◆ ReflectiveImageRegionIterator() [4/4]

template<typename TImage >
itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( const ReflectiveImageRegionConstIterator< TImage > &  it)
protected

the construction from a const iterator is declared protected in order to enforce const correctness.

Member Function Documentation

◆ operator=()

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

the construction from a const iterator is declared protected in order to enforce const correctness.

◆ Set()

template<typename TImage >
void itk::ReflectiveImageRegionIterator< TImage >::Set ( const PixelType value) const
inline

Set the pixel value

Definition at line 85 of file itkReflectiveImageRegionIterator.h.

◆ Value()

template<typename TImage >
PixelType& itk::ReflectiveImageRegionIterator< TImage >::Value ( )
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 94 of file itkReflectiveImageRegionIterator.h.


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