ITK
6.0.0
Insight Toolkit
|
#include <itkImageScanlineIterator.h>
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.
Definition at line 42 of file itkImageScanlineIterator.h.
Public Types | |
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 = ImageScanlineIterator |
using | SizeType = typename TImage::SizeType |
using | Superclass = ImageScanlineConstIterator< TImage > |
Public Types inherited from itk::ImageScanlineConstIterator< TImage > | |
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 = ImageScanlineConstIterator |
using | SizeType = typename TImage::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 (TImage *ptr, const RegionType ®ion) | |
void | Set (const PixelType &value) const |
PixelType & | Value () |
Public Member Functions inherited from itk::ImageScanlineConstIterator< TImage > | |
const char * | GetNameOfClass () const override |
void | GoToBegin () |
void | GoToBeginOfLine () |
void | GoToEnd () |
void | GoToEndOfLine () |
ImageScanlineConstIterator (const ImageConstIterator< TImage > &it) | |
ImageScanlineConstIterator (const ImageIterator< TImage > &it) | |
bool | IsAtEndOfLine () const |
void | NextLine () |
ImageScanlineConstIterator () | |
ImageScanlineConstIterator (const TImage *ptr, const RegionType ®ion) | |
void | SetIndex (const IndexType &ind) override |
Self & | operator++ () |
Self & | operator-- () |
Public Member Functions inherited from itk::ImageConstIterator< TImage > | |
PixelType | Get () const |
const ImageType * | GetImage () const |
const IndexType | GetIndex () const |
virtual const char * | GetNameOfClass () const |
const RegionType & | GetRegion () const |
void | GoToBegin () |
void | GoToEnd () |
ImageConstIterator (const Self &it) | |
bool | IsAtBegin () const |
bool | IsAtEnd () const |
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self) | |
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 |
virtual void | SetIndex (const IndexType &ind) |
virtual void | SetRegion (const RegionType ®ion) |
const PixelType & | Value () const |
virtual | ~ImageConstIterator ()=default |
ImageConstIterator () | |
ImageConstIterator (const ImageType *ptr, const RegionType ®ion) | |
Self & | operator= (const Self &it) |
Protected Member Functions | |
ImageScanlineIterator (const ImageScanlineConstIterator< TImage > &it) | |
Self & | operator= (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 > | |
OffsetValueType | m_BeginOffset {} |
const InternalPixelType * | m_Buffer {} |
OffsetValueType | m_EndOffset {} |
TImage::ConstWeakPointer | m_Image {} |
OffsetValueType | m_Offset {} |
AccessorType | m_PixelAccessor {} |
AccessorFunctorType | m_PixelAccessorFunctor {} |
RegionType | m_Region {} |
using itk::ImageConstIterator< TImage >::AccessorType = typename TImage::AccessorType |
Accessor type that convert data between internal and external representations.
Definition at line 128 of file itkImageConstIterator.h.
using itk::ImageConstIterator< TImage >::ImageType = TImage |
Image type alias support
Definition at line 112 of file itkImageConstIterator.h.
using itk::ImageConstIterator< TImage >::IndexType = typename TImage::IndexType |
Index type alias support
Definition at line 100 of file itkImageConstIterator.h.
using itk::ImageConstIterator< TImage >::InternalPixelType = typename TImage::InternalPixelType |
Internal Pixel Type
Definition at line 121 of file itkImageConstIterator.h.
using itk::ImageConstIterator< TImage >::OffsetType = typename TImage::OffsetType |
Offset type alias support
Definition at line 106 of file itkImageConstIterator.h.
using itk::ImageConstIterator< TImage >::PixelContainer = typename TImage::PixelContainer |
PixelContainer type alias support. Used to refer to the container for the pixel data. While this was already typedef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.
Definition at line 117 of file itkImageConstIterator.h.
using itk::ImageConstIterator< TImage >::PixelContainerPointer = typename PixelContainer::Pointer |
Definition at line 118 of file itkImageConstIterator.h.
using itk::ImageConstIterator< TImage >::PixelType = typename TImage::PixelType |
External Pixel Type
Definition at line 124 of file itkImageConstIterator.h.
using itk::ImageConstIterator< TImage >::RegionType = typename TImage::RegionType |
Region type alias support
Definition at line 109 of file itkImageConstIterator.h.
using itk::ImageScanlineIterator< TImage >::Self = ImageScanlineIterator |
Standard class type aliases.
Definition at line 46 of file itkImageScanlineIterator.h.
using itk::ImageConstIterator< TImage >::SizeType = typename TImage::SizeType |
Size type alias support
Definition at line 103 of file itkImageConstIterator.h.
using itk::ImageScanlineIterator< TImage >::Superclass = ImageScanlineConstIterator<TImage> |
Definition at line 47 of file itkImageScanlineIterator.h.
|
default |
Default constructor. Needed since we provide a cast constructor.
itk::ImageScanlineIterator< TImage >::ImageScanlineIterator | ( | TImage * | ptr, |
const RegionType & | region | ||
) |
Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes the iterator at the begin of the region.
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.
|
protected |
the construction from a const iterator is declared protected in order to enforce const correctness.
|
protected |
the construction from a const iterator is declared protected in order to enforce const correctness.
|
inline |
Set the pixel value
Definition at line 78 of file itkImageScanlineIterator.h.
|
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.