ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > > Class Template Reference

#include <itkRLEImageConstIterator.h>

+ Inheritance diagram for itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >:
+ Collaboration diagram for itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >:

Detailed Description

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

Definition at line 42 of file itkRLEImageConstIterator.h.

Public Types

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

PixelType Get (void) const
 
const ImageTypeGetImage () const
 
const IndexType GetIndex () const
 
const RegionType GetRegion () const
 
bool IsAtBegin (void) const
 
bool IsAtEnd (void) const
 
 itkTypeMacroNoParent (ImageConstIterator)
 
const PixelTypeValue (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 ()
 

Static Public Attributes

static constexpr unsigned int ImageIteratorDimension = VImageDimension
 

Friends

class ::MultiLabelMeshPipeline
 
Selfoperator= (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 unsigned int GetImageIteratorDimension ()
 
ImageType::ConstWeakPointer m_Image
 
IndexValueType m_Index0
 
const RLLinem_RunLengthLine
 
SizeValueType m_RealIndex
 
IndexValueType m_SegmentRemainder
 
IndexValueType m_BeginIndex0
 
IndexValueType m_EndIndex0
 
BufferIterator m_BI
 
BufferType::Pointer m_Buffer
 
virtual void SetIndexInternal (const IndexValueType ind0)
 

Member Typedef Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::BufferIterator = ImageRegionIterator< BufferType >

Type for the internal buffer iterator.

Definition at line 69 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::BufferType = typename ImageType::BufferType

Buffer Type used.

Definition at line 66 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageType = RLEImage< TPixel, VImageDimension, CounterType >

Image type alias support.

Definition at line 60 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::IndexType = typename ImageType::IndexType

Index type alias support.

Definition at line 72 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::IndexValueType = typename ImageType::IndexValueType

Index type alias support.

Definition at line 75 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::InternalPixelType = typename ImageType::InternalPixelType

Internal Pixel Type

Definition at line 87 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::OffsetType = typename ImageType::OffsetType

Offset type alias support.

Definition at line 81 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::PixelType = typename ImageType::PixelType

External Pixel Type

Definition at line 90 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::RegionType = typename ImageType::RegionType

Region type alias support.

Definition at line 84 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::RLLine = typename ImageType::RLLine

Run-Length Line (we iterate along it).

Definition at line 63 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::Self = ImageConstIterator

Standard class type alias.

Definition at line 48 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::SizeType = typename ImageType::SizeType

Size type alias support.

Definition at line 78 of file itkRLEImageConstIterator.h.

Constructor & Destructor Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageConstIterator ( )
inline

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

Definition at line 94 of file itkRLEImageConstIterator.h.

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

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
virtual itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::~ImageConstIterator ( )
inlinevirtual

Default Destructor.

Definition at line 108 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageConstIterator ( 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 112 of file itkRLEImageConstIterator.h.

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

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageConstIterator ( 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 129 of file itkRLEImageConstIterator.h.

References itk::ImageConstIterator< TImage >::m_Image, and itk::ImageConstIterator< TImage >::SetRegion().

Member Function Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
PixelType itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::Get ( void  ) const
inline

Get the pixel value

Definition at line 326 of file itkRLEImageConstIterator.h.

References itk::ImageConstIterator< TImage >::Value().

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
const ImageType* itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GetImage ( ) const
inline

Get the image that this iterator walks.

Definition at line 319 of file itkRLEImageConstIterator.h.

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

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
static unsigned int itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GetImageIteratorDimension ( )
inlinestatic

Get the dimension (size) of the index.

Definition at line 181 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
const IndexType itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GetIndex ( ) const
inline

Get the index. This provides a read only copy of the index.

Definition at line 272 of file itkRLEImageConstIterator.h.

References itk::Index< VDimension >::GetIndex(), and itk::ImageConstIterator< TImage >::m_Image.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
const RegionType itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GetRegion ( ) const
inline

Get the region that this iterator walks. ImageConstIterators know the beginning and the end of the region of the image to iterate over.

Definition at line 302 of file itkRLEImageConstIterator.h.

References itk::ImageConstIterator< TImage >::m_Image, and itk::ImageRegion< VImageDimension >::SetIndex().

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
void itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GoToBegin ( )
inline

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.

Definition at line 345 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
void itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GoToEnd ( )
inline

Move an iterator to the end of the region. "End" is defined as one pixel past the last pixel of the region.

Definition at line 355 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::IsAtBegin ( void  ) const
inline

Is the iterator at the beginning of the region? "Begin" is defined as the first pixel in the region.

Definition at line 365 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::IsAtEnd ( void  ) const
inline

Is the iterator at the end of the region? "End" is defined as one pixel past the last pixel of the region.

Definition at line 373 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::itkTypeMacroNoParent ( ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >  )

Run-time type information (and related methods).

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator!= ( const Self it) const
inline

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 189 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator< ( const Self it) const
inline

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 222 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator<= ( const Self it) const
inline

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 205 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
Self& itk::ImageConstIterator< 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 140 of file itkRLEImageConstIterator.h.

References itk::ImageConstIterator< TImage >::m_Buffer, and itk::ImageConstIterator< TImage >::m_Image.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator== ( const Self it) const
inline

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 197 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator> ( const Self it) const
inline

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 256 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator>= ( const Self it) const
inline

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 239 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
virtual void itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::SetIndex ( const IndexType ind)
inlinevirtual

Sets the image index. No bounds checking is performed.

Definition at line 287 of file itkRLEImageConstIterator.h.

References itk::ImageConstIterator< TImage >::m_Image, and itk::Index< VDimension >::SetIndex().

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
virtual void itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::SetIndexInternal ( const IndexValueType  ind0)
inlineprotectedvirtual

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 381 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
virtual void itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::SetRegion ( const RegionType region)
inlinevirtual
template<typename TPixel , unsigned int VImageDimension, typename CounterType >
const PixelType& itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::Value ( void  ) const
inline

Return a const reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 335 of file itkRLEImageConstIterator.h.

References itk::ImageConstIterator< TImage >::Value().

Friends And Related Function Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
friend class ::MultiLabelMeshPipeline
friend

Definition at line 44 of file itkRLEImageConstIterator.h.

Member Data Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
constexpr unsigned int itk::ImageConstIterator< 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 54 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
IndexValueType itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_BeginIndex0
protected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 410 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
BufferIterator itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_BI
protected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 412 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
BufferType::Pointer itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_Buffer
protected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 414 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
IndexValueType itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_EndIndex0
protected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 411 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
ImageType::ConstWeakPointer itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_Image
protected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 401 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
IndexValueType itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_Index0
protected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 403 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
SizeValueType itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_RealIndex
mutableprotected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 407 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
const RLLine* itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_RunLengthLine
protected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 405 of file itkRLEImageConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
IndexValueType itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::m_SegmentRemainder
mutableprotected

Set the internal index, m_RealIndex and m_SegmentRemainder.

Definition at line 408 of file itkRLEImageConstIterator.h.


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