itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > > Class Template Reference

#include <itkRLEImageIterator.h>

Inheritance diagram for itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >:

Collaboration diagram for itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >:

Detailed Description

template<typename TPixel, unsigned int VImageDimension, typename CounterType>
class itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >

Definition at line 36 of file itkRLEImageIterator.h.

Public Types
using	ImageType = typename Superclass::ImageType
using	IndexType = typename Superclass::IndexType
using	InternalPixelType = typename Superclass::InternalPixelType
using	OffsetType = typename Superclass::OffsetType
using	PixelType = typename Superclass::PixelType
using	RegionType = typename Superclass::RegionType
using	Self = ImageIterator
using	SizeType = typename Superclass::SizeType
using	Superclass = ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
Public Types inherited from itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
using	BufferIterator = ImageRegionIterator< BufferType >
using	BufferType = typename ImageType::BufferType
using	ImageType = RLEImage< TPixel, VImageDimension, CounterType >
using	IndexType = typename ImageType::IndexType
using	IndexValueType = typename ImageType::IndexValueType
using	InternalPixelType = typename ImageType::InternalPixelType
using	OffsetType = typename ImageType::OffsetType
using	PixelType = typename ImageType::PixelType
using	RegionType = typename ImageType::RegionType
using	RLLine = typename ImageType::RLLine
using	Self = ImageConstIterator
using	SizeType = typename ImageType::SizeType

Public Member Functions
ImageType *	GetImage () const
	ImageIterator ()
	ImageIterator (const Self &it)
	ImageIterator (ImageType *ptr, const RegionType &region)
void	Set (const PixelType &value) const
	~ImageIterator () override
Self &	operator= (const Self &it)
Public Member Functions inherited from itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
PixelType	Get (void) const
const ImageType *	GetImage () const
const IndexType	GetIndex () const
const RegionType	GetRegion () const
bool	IsAtBegin (void) const
bool	IsAtEnd (void) const
	itkTypeMacroNoParent (ImageConstIterator)
const PixelType &	Value (void) const
virtual	~ImageConstIterator ()
	ImageConstIterator ()
	ImageConstIterator (const Self &it)
	ImageConstIterator (const ImageType *ptr, const RegionType &region)
bool	operator< (const Self &it) const
bool	operator>= (const Self &it) const
bool	operator> (const Self &it) const
virtual void	SetIndex (const IndexType &ind)
void	GoToBegin ()
void	GoToEnd ()
Self &	operator= (const Self &it)
virtual void	SetRegion (const RegionType &region)
bool	operator!= (const Self &it) const
bool	operator== (const Self &it) const
bool	operator<= (const Self &it) const

Static Public Attributes
static constexpr unsigned int	ImageIteratorDimension = VImageDimension
Static Public Attributes inherited from itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
static constexpr unsigned int	ImageIteratorDimension = VImageDimension

Protected Member Functions
	ImageIterator (const ImageConstIterator< ImageType > &it)
Self &	operator= (const ImageConstIterator< ImageType > &it)
Protected Member Functions inherited from itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
virtual void	SetIndexInternal (const IndexValueType ind0)

Member Typedef Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageType = typename Superclass::ImageType

Definition at line 57 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::IndexType = typename Superclass::IndexType

Inherit types from the superclass

Definition at line 53 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 58 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::OffsetType = typename Superclass::OffsetType

Definition at line 55 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::PixelType = typename Superclass::PixelType

Definition at line 59 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::RegionType = typename Superclass::RegionType

Definition at line 56 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::Self = ImageIterator

Standard class type alias.

Definition at line 41 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::SizeType = typename Superclass::SizeType

Definition at line 54 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

using itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::Superclass = ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >

Define the superclass

Definition at line 50 of file itkRLEImageIterator.h.

Constructor & Destructor Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageIterator ( )

inline

Default Constructor. Need to provide a default constructor since we provide a copy constructor.

Definition at line 63 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::~ImageIterator ( )

inlineoverride

Default Destructor

Definition at line 66 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageIterator ( const Self &  it )

inline

Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.

Definition at line 70 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageIterator ( 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 76 of file itkRLEImageIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageIterator ( const ImageConstIterator< ImageType > &  it )

inlineprotected

This constructor is declared protected in order to enforce const-correctness

Definition at line 121 of file itkRLEImageIterator.h.

Member Function Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

ImageType* itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GetImage ( ) const

inline

Return a reference to the pixel Setting this value would change value of the whole run-length segment. If we wanted to safely enable it, we would isolate this pixel into its own segment. Get the image that this iterator walks.

Definition at line 111 of file itkRLEImageIterator.h.

References itk::ImageConstIterator< TImage >::m_Image.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

Self& itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator= ( const Self &  it )

inline

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

Definition at line 83 of file itkRLEImageIterator.h.

References itk::ImageConstIterator< TImage >::operator=().

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

Self& itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator= ( const ImageConstIterator< ImageType > &  it )

inlineprotected

This constructor is declared protected in order to enforce const-correctness

Definition at line 125 of file itkRLEImageIterator.h.

References itk::ImageConstIterator< TImage >::operator=().

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

void itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::Set ( const PixelType &  value ) const

inline

Set the pixel value. Changing the RLE structure invalidates all other iterators (except this one).

Definition at line 93 of file itkRLEImageIterator.h.

References itk::ImageConstIterator< TImage >::m_Image.

Member Data Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >

constexpr unsigned int itk::ImageIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageIteratorDimension = VImageDimension

static

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.

Definition at line 47 of file itkRLEImageIterator.h.

---

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

• itkRLEImageIterator.h