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

#include <itkRLEImageRegionConstIterator.h>

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

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

Detailed Description

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

Definition at line 42 of file itkRLEImageRegionConstIterator.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 = ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
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
virtual const char *	GetNameOfClass () const
	ImageRegionConstIterator ()
	ImageRegionConstIterator (const ImageType *ptr, const RegionType &region)
	ImageRegionConstIterator (const ImageIterator< ImageType > &it)
	ImageRegionConstIterator (const ImageConstIterator< ImageType > &it)
Self &	operator++ ()
Self &	operator-- ()
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

Friends
class	::MultiLabelMeshPipeline

Member Typedef Documentation

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

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

Definition at line 68 of file itkRLEImageRegionConstIterator.h.

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

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

Index type alias support While these were already typdef'ed in the superclass, they need to be redone here for this subclass to compile properly with gcc.Types inherited from the Superclass

Definition at line 64 of file itkRLEImageRegionConstIterator.h.

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

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

Definition at line 69 of file itkRLEImageRegionConstIterator.h.

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

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

Definition at line 66 of file itkRLEImageRegionConstIterator.h.

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

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

Definition at line 70 of file itkRLEImageRegionConstIterator.h.

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

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

Definition at line 67 of file itkRLEImageRegionConstIterator.h.

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

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

Standard class type alias.

Definition at line 49 of file itkRLEImageRegionConstIterator.h.

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

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

Definition at line 65 of file itkRLEImageRegionConstIterator.h.

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

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

Definition at line 50 of file itkRLEImageRegionConstIterator.h.

Constructor & Destructor Documentation

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

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

inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 76 of file itkRLEImageRegionConstIterator.h.

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

itk::ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageRegionConstIterator ( const 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 82 of file itkRLEImageRegionConstIterator.h.

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

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

inline

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

Definition at line 92 of file itkRLEImageRegionConstIterator.h.

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

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

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

inline

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

Definition at line 103 of file itkRLEImageRegionConstIterator.h.

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

Member Function Documentation

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

virtual const char* itk::ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented in itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >.

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

Self& itk::ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator++ ( )

inline

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)

Definition at line 116 of file itkRLEImageRegionConstIterator.h.

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

Self& itk::ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator-- ( )

inline

Decrement (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 beginning of the row of the region to the end of the next row of the region) up until the iterator tries to moves past the first pixel of the region. Here, the iterator will be set to be one pixel past the beginning of the region.

See Also

operator--(int)

Definition at line 153 of file itkRLEImageRegionConstIterator.h.

Friends And Related Function Documentation

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

friend class ::MultiLabelMeshPipeline

friend

Definition at line 45 of file itkRLEImageRegionConstIterator.h.

Member Data Documentation

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

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

static

Dimension of the image that 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 56 of file itkRLEImageRegionConstIterator.h.

---

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

• itkRLEImageRegionConstIterator.h