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

#include <itkRLEImageScanlineIterator.h>

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

Detailed Description

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

Definition at line 35 of file itkRLEImageScanlineIterator.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 = ImageScanlineIterator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
 
- Public Types inherited from itk::ImageScanlineConstIterator< 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 = 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

 ImageScanlineIterator ()
 
 ImageScanlineIterator (ImageType *ptr, const RegionType &region)
 
 ImageScanlineIterator (const ImageIterator< ImageType > &it)
 
void Set (const PixelType &value) const
 
- Public Member Functions inherited from itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
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
 

Protected Member Functions

 ImageScanlineIterator (const ImageScanlineConstIterator< ImageType > &it)
 
Selfoperator= (const ImageScanlineConstIterator< ImageType > &it)
 
- Protected Member Functions inherited from itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
virtual void SetIndexInternal (const IndexValueType ind0)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
static unsigned int GetImageIteratorDimension ()
 
- Static Public Attributes inherited from itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
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
 
- Protected Attributes inherited from itk::ImageConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >
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
 

Member Typedef Documentation

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

Definition at line 48 of file itkRLEImageScanlineIterator.h.

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

Types inherited from the Superclass

Definition at line 44 of file itkRLEImageScanlineIterator.h.

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

Definition at line 49 of file itkRLEImageScanlineIterator.h.

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

Definition at line 46 of file itkRLEImageScanlineIterator.h.

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

Definition at line 50 of file itkRLEImageScanlineIterator.h.

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

Definition at line 47 of file itkRLEImageScanlineIterator.h.

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

Standard class type alias.

Definition at line 40 of file itkRLEImageScanlineIterator.h.

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

Definition at line 45 of file itkRLEImageScanlineIterator.h.

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

Definition at line 41 of file itkRLEImageScanlineIterator.h.

Constructor & Destructor Documentation

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

Default constructor. Needed since we provide a cast constructor.

Definition at line 53 of file itkRLEImageScanlineIterator.h.

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

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

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

Definition at line 69 of file itkRLEImageScanlineIterator.h.

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

Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors. the construction from a const iterator is declared protected in order to enforce const correctness.

Definition at line 93 of file itkRLEImageScanlineIterator.h.

Member Function Documentation

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
Self& itk::ImageScanlineIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator= ( const ImageScanlineConstIterator< ImageType > &  it)
inlineprotected

Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors. the construction from a const iterator is declared protected in order to enforce const correctness.

Definition at line 97 of file itkRLEImageScanlineIterator.h.

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

template<typename TPixel , unsigned int VImageDimension, typename CounterType >
void itk::ImageScanlineIterator< RLEImage< TPixel, VImageDimension, CounterType > >::Set ( const PixelType value) const
inline

Set the pixel value

Definition at line 75 of file itkRLEImageScanlineIterator.h.

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


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