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

#include <itkRLEImageScanlineConstIterator.h>

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

Detailed Description

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

Definition at line 34 of file itkRLEImageScanlineConstIterator.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 = ImageScanlineConstIterator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
 
- Public Types inherited from itk::ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
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
 
 ImageScanlineConstIterator ()
 
 ImageScanlineConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageScanlineConstIterator (const ImageIterator< ImageType > &it)
 
 ImageScanlineConstIterator (const ImageConstIterator< ImageType > &it)
 
bool IsAtEndOfLine (void)
 
void GoToBeginOfLine (void)
 
void GoToEndOfLine (void)
 
void NextLine (void)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
 ImageRegionConstIterator ()
 
 ImageRegionConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageRegionConstIterator (const ImageIterator< ImageType > &it)
 
 ImageRegionConstIterator (const ImageConstIterator< ImageType > &it)
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
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 ()
 
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 Public Attributes

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

Member Typedef Documentation

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

Definition at line 58 of file itkRLEImageScanlineConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageScanlineConstIterator< 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 54 of file itkRLEImageScanlineConstIterator.h.

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

Definition at line 59 of file itkRLEImageScanlineConstIterator.h.

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

Definition at line 56 of file itkRLEImageScanlineConstIterator.h.

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

Definition at line 60 of file itkRLEImageScanlineConstIterator.h.

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

Definition at line 57 of file itkRLEImageScanlineConstIterator.h.

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

Standard class type alias.

Definition at line 39 of file itkRLEImageScanlineConstIterator.h.

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

Definition at line 55 of file itkRLEImageScanlineConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
using itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::Superclass = ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >

Definition at line 40 of file itkRLEImageScanlineConstIterator.h.

Constructor & Destructor Documentation

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

Default constructor. Needed since we provide a cast constructor.

Definition at line 66 of file itkRLEImageScanlineConstIterator.h.

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

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageScanlineConstIterator ( const ImageIterator< ImageType > &  it)
inline

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

Definition at line 82 of file itkRLEImageScanlineConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::ImageScanlineConstIterator ( const ImageConstIterator< ImageType > &  it)
inline

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

Definition at line 92 of file itkRLEImageScanlineConstIterator.h.

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

Member Function Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
virtual const char* itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageRegionConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >.

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

Go to the beginning pixel of the current line.

Definition at line 99 of file itkRLEImageScanlineConstIterator.h.

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

Go to the past end pixel of the current line.

Definition at line 109 of file itkRLEImageScanlineConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
bool itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::IsAtEndOfLine ( void  )
inline

Test if the index is at the end of line.

Definition at line 119 of file itkRLEImageScanlineConstIterator.h.

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

Go to the next line.

Definition at line 126 of file itkRLEImageScanlineConstIterator.h.

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
Self& itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator++ ( )
inline

Increment (prefix) along the scanline.

If the iterator is at the end of the scanline ( one past the last valid element in the row ), then the results are undefined. Which means is may assert in debug mode or result in an undefined iterator which may have unknown consequences if used.

Definition at line 148 of file itkRLEImageScanlineConstIterator.h.

References itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine().

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
Self& itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator-- ( )
inline

Decrement (prefix) along the scanline.

Definition at line 172 of file itkRLEImageScanlineConstIterator.h.

Member Data Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
constexpr unsigned int itk::ImageScanlineConstIterator< 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 46 of file itkRLEImageScanlineConstIterator.h.


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