ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::ImageScanlineIterator< TImage > Class Template Reference

#include <itkImageScanlineIterator.h>

+ Inheritance diagram for itk::ImageScanlineIterator< TImage >:
+ Collaboration diagram for itk::ImageScanlineIterator< TImage >:

Public Types

using AccessorType = typename Superclass::AccessorType
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename Superclass::IndexType
 
using InternalPixelType = typename Superclass::InternalPixelType
 
using OffsetType = typename Superclass::OffsetType
 
using PixelContainer = typename Superclass::PixelContainer
 
using PixelContainerPointer = typename Superclass::PixelContainerPointer
 
using PixelType = typename Superclass::PixelType
 
using RegionType = typename Superclass::RegionType
 
using Self = ImageScanlineIterator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageScanlineConstIterator< TImage >
 
- Public Types inherited from itk::ImageScanlineConstIterator< TImage >
using AccessorType = typename Superclass::AccessorType
 
using ImageType = typename Superclass::ImageType
 
using IndexType = typename Superclass::IndexType
 
using InternalPixelType = typename Superclass::InternalPixelType
 
using OffsetType = typename Superclass::OffsetType
 
using PixelContainer = typename Superclass::PixelContainer
 
using PixelContainerPointer = typename Superclass::PixelContainerPointer
 
using PixelType = typename Superclass::PixelType
 
using RegionType = typename Superclass::RegionType
 
using Self = ImageScanlineConstIterator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = ImageConstIterator< TImage >
 
- Public Types inherited from itk::ImageConstIterator< TImage >
using AccessorFunctorType = typename TImage::AccessorFunctorType
 
using AccessorType = typename TImage::AccessorType
 
using ImageType = TImage
 
using IndexType = typename TImage::IndexType
 
using InternalPixelType = typename TImage::InternalPixelType
 
using OffsetType = typename TImage::OffsetType
 
using PixelContainer = typename TImage::PixelContainer
 
using PixelContainerPointer = typename PixelContainer::Pointer
 
using PixelType = typename TImage::PixelType
 
using RegionType = typename TImage::RegionType
 
using Self = ImageConstIterator
 
using SizeType = typename TImage::SizeType
 

Public Member Functions

 ImageScanlineIterator ()=default
 
 ImageScanlineIterator (const ImageIterator< TImage > &it)
 
 ImageScanlineIterator (ImageType *ptr, const RegionType &region)
 
void Set (const PixelType &value) const
 
PixelTypeValue ()
 
- Public Member Functions inherited from itk::ImageScanlineConstIterator< TImage >
virtual const char * GetNameOfClass () const
 
 ImageScanlineConstIterator ()
 
 ImageScanlineConstIterator (const ImageType *ptr, const RegionType &region)
 
 ImageScanlineConstIterator (const ImageIterator< TImage > &it)
 
 ImageScanlineConstIterator (const ImageConstIterator< TImage > &it)
 
void GoToBegin ()
 
void GoToEnd ()
 
void GoToBeginOfLine ()
 
void GoToEndOfLine ()
 
bool IsAtEndOfLine () const
 
void SetIndex (const IndexType &ind) override
 
void NextLine ()
 
Selfoperator++ ()
 
Selfoperator-- ()
 
- Public Member Functions inherited from itk::ImageConstIterator< TImage >
 itkTypeMacroNoParent (ImageConstIterator)
 
 ImageConstIterator ()
 
virtual ~ImageConstIterator ()=default
 
 ImageConstIterator (const Self &it)
 
 ImageConstIterator (const ImageType *ptr, const RegionType &region)
 
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
 
bool operator< (const Self &it) const
 
bool operator>= (const Self &it) const
 
bool operator> (const Self &it) const
 
const IndexType GetIndex () const
 
const RegionTypeGetRegion () const
 
const ImageTypeGetImage () const
 
PixelType Get () const
 
const PixelTypeValue () const
 
void GoToBegin ()
 
void GoToEnd ()
 
bool IsAtBegin () const
 
bool IsAtEnd () const
 

Protected Member Functions

 ImageScanlineIterator (const ImageScanlineConstIterator< TImage > &it)
 
Selfoperator= (const ImageScanlineConstIterator< TImage > &it)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageConstIterator< TImage >
static unsigned int GetImageIteratorDimension ()
 
- Static Public Attributes inherited from itk::ImageScanlineConstIterator< TImage >
static constexpr unsigned int ImageIteratorDimension = Superclass::ImageIteratorDimension
 
- Static Public Attributes inherited from itk::ImageConstIterator< TImage >
static constexpr unsigned int ImageIteratorDimension = TImage::ImageDimension
 
- Protected Attributes inherited from itk::ImageScanlineConstIterator< TImage >
OffsetValueType m_SpanBeginOffset
 
OffsetValueType m_SpanEndOffset
 
- Protected Attributes inherited from itk::ImageConstIterator< TImage >
TImage::ConstWeakPointer m_Image
 
RegionType m_Region
 
OffsetValueType m_Offset
 
OffsetValueType m_BeginOffset
 
OffsetValueType m_EndOffset
 
const InternalPixelTypem_Buffer
 
AccessorType m_PixelAccessor
 
AccessorFunctorType m_PixelAccessorFunctor
 

Detailed Description

template<typename TImage>
class itk::ImageScanlineIterator< TImage >

A multi-dimensional iterator templated over image type that walks a region of pixels, scanline by scanline or in the direction of the fastest axis.

The itk::ImageScanlineIterator is optimized for iteration speed and is the first choice for pixel-wise operations on an image. This iterator is preferred over the older ImageRegionIterator even when knowledge of the current line state is not desired because of its speed.

See also
ImageScanlineConstIterator
ImageRegionIterator

Definition at line 42 of file itkImageScanlineIterator.h.

Member Typedef Documentation

◆ AccessorType

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 59 of file itkImageScanlineIterator.h.

◆ ImageType

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::ImageType = typename Superclass::ImageType

Definition at line 54 of file itkImageScanlineIterator.h.

◆ IndexType

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::IndexType = typename Superclass::IndexType

Types inherited from the Superclass

Definition at line 50 of file itkImageScanlineIterator.h.

◆ InternalPixelType

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 57 of file itkImageScanlineIterator.h.

◆ OffsetType

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 52 of file itkImageScanlineIterator.h.

◆ PixelContainer

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 55 of file itkImageScanlineIterator.h.

◆ PixelContainerPointer

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 56 of file itkImageScanlineIterator.h.

◆ PixelType

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::PixelType = typename Superclass::PixelType

Definition at line 58 of file itkImageScanlineIterator.h.

◆ RegionType

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::RegionType = typename Superclass::RegionType

Definition at line 53 of file itkImageScanlineIterator.h.

◆ Self

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::Self = ImageScanlineIterator

Standard class type aliases.

Definition at line 46 of file itkImageScanlineIterator.h.

◆ SizeType

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::SizeType = typename Superclass::SizeType

Definition at line 51 of file itkImageScanlineIterator.h.

◆ Superclass

template<typename TImage >
using itk::ImageScanlineIterator< TImage >::Superclass = ImageScanlineConstIterator<TImage>

Definition at line 47 of file itkImageScanlineIterator.h.

Constructor & Destructor Documentation

◆ ImageScanlineIterator() [1/4]

template<typename TImage >
itk::ImageScanlineIterator< TImage >::ImageScanlineIterator ( )
default

Default constructor. Needed since we provide a cast constructor.

◆ ImageScanlineIterator() [2/4]

template<typename TImage >
itk::ImageScanlineIterator< TImage >::ImageScanlineIterator ( ImageType ptr,
const RegionType region 
)

Constructor establishes an iterator to walk a particular image and a particular region of that image.

◆ ImageScanlineIterator() [3/4]

template<typename TImage >
itk::ImageScanlineIterator< TImage >::ImageScanlineIterator ( const ImageIterator< TImage > &  it)

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.

◆ ImageScanlineIterator() [4/4]

template<typename TImage >
itk::ImageScanlineIterator< TImage >::ImageScanlineIterator ( const ImageScanlineConstIterator< TImage > &  it)
protected

the construction from a const iterator is declared protected in order to enforce const correctness.

Member Function Documentation

◆ operator=()

template<typename TImage >
Self& itk::ImageScanlineIterator< TImage >::operator= ( const ImageScanlineConstIterator< TImage > &  it)
protected

the construction from a const iterator is declared protected in order to enforce const correctness.

◆ Set()

template<typename TImage >
void itk::ImageScanlineIterator< TImage >::Set ( const PixelType value) const
inline

Set the pixel value

Definition at line 78 of file itkImageScanlineIterator.h.

◆ Value()

template<typename TImage >
PixelType& itk::ImageScanlineIterator< TImage >::Value ( )
inline

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

Definition at line 87 of file itkImageScanlineIterator.h.


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