ITK
6.0.0
Insight Toolkit
|
#include <itkLineConstIterator.h>
An iterator that walks a Bresenham line through an ND image with read-only access to pixels.
LineConstIterator is an iterator that walks a Bresenham line through an image. The iterator is constructed similar to other image iterators, except instead of specifying a region to traverse, you specify two indices. The interval specified by the two indices is closed. So, a line iterator specified with the same start and end index will visit exactly one pixel.
Definition at line 56 of file itkLineConstIterator.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 | PointType = typename TImage::PointType |
using | RegionType = typename TImage::RegionType |
using | Self = LineConstIterator |
using | SizeType = typename TImage::SizeType |
using | SpacingType = typename TImage::SpacingType |
Public Member Functions | |
const PixelType | Get () const |
const IndexType | GetIndex () |
virtual const char * | GetNameOfClass () const |
void | GoToBegin () |
bool | IsAtEnd () const |
LineConstIterator (const ImageType *imagePtr, const IndexType &firstIndex, const IndexType &lastIndex) | |
void | operator++ () |
Self & | operator= (const Self &it) |
virtual | ~LineConstIterator ()=default |
Static Public Member Functions | |
static unsigned int | GetImageIteratorDimension () |
Static Public Attributes | |
static constexpr unsigned int | ImageIteratorDimension = TImage::ImageDimension |
Protected Attributes | |
IndexType | m_AccumulateError {} |
IndexType | m_CurrentImageIndex {} |
IndexType | m_EndIndex {} |
ImageType::ConstWeakPointer | m_Image {} |
IndexType | m_IncrementError {} |
bool | m_IsAtEnd {} |
IndexType | m_LastIndex {} |
unsigned int | m_MainDirection {} |
IndexType | m_MaximalError {} |
IndexType | m_OverflowIncrement {} |
IndexType | m_ReduceErrorAfterIncrement {} |
RegionType | m_Region {} |
IndexType | m_StartIndex {} |
using itk::LineConstIterator< TImage >::AccessorType = typename TImage::AccessorType |
Accessor type that convert data between internal and external representations.
Definition at line 104 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::ImageType = TImage |
Image type alias support
Definition at line 88 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::IndexType = typename TImage::IndexType |
Index type alias support
Definition at line 70 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::InternalPixelType = typename TImage::InternalPixelType |
Internal Pixel Type
Definition at line 97 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::OffsetType = typename TImage::OffsetType |
Offset type alias support
Definition at line 73 of file itkLineConstIterator.h.
using itk::LineConstIterator< 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 93 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::PixelContainerPointer = typename PixelContainer::Pointer |
Definition at line 94 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::PixelType = typename TImage::PixelType |
External Pixel Type
Definition at line 100 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::PointType = typename TImage::PointType |
Origin type alias support
Definition at line 85 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::RegionType = typename TImage::RegionType |
Region type alias support
Definition at line 79 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::Self = LineConstIterator |
Standard class type aliases.
Definition at line 61 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::SizeType = typename TImage::SizeType |
Size type alias support
Definition at line 76 of file itkLineConstIterator.h.
using itk::LineConstIterator< TImage >::SpacingType = typename TImage::SpacingType |
Spacing type alias support
Definition at line 82 of file itkLineConstIterator.h.
itk::LineConstIterator< TImage >::LineConstIterator | ( | const ImageType * | imagePtr, |
const IndexType & | firstIndex, | ||
const IndexType & | lastIndex | ||
) |
Constructor establishes an iterator to walk along a line
|
virtualdefault |
Default Destructor.
|
inline |
Get the pixel value
Definition at line 125 of file itkLineConstIterator.h.
|
inlinestatic |
Get the dimension (size) of the index.
Definition at line 111 of file itkLineConstIterator.h.
|
inline |
Get the index. This provides a read only reference to the index.
Definition at line 118 of file itkLineConstIterator.h.
|
virtual |
Reimplemented in itk::LineIterator< TImage >.
void itk::LineConstIterator< TImage >::GoToBegin | ( | ) |
Move an iterator to the beginning of the line.
|
inline |
Is the iterator at the end of the line?
Definition at line 132 of file itkLineConstIterator.h.
void itk::LineConstIterator< TImage >::operator++ | ( | ) |
Walk forward along the line to the next index in the image.
Self & itk::LineConstIterator< TImage >::operator= | ( | const Self & | it | ) |
operator= is provided to make sure the handle to the image is properly reference counted.
|
staticconstexpr |
Dimension of the image that the iterator walks. This constant is needed so that 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 67 of file itkLineConstIterator.h.
|
protected |
Definition at line 177 of file itkLineConstIterator.h.
|
protected |
Start, end and current ND index position in the image of the line
Definition at line 167 of file itkLineConstIterator.h.
|
protected |
Definition at line 170 of file itkLineConstIterator.h.
|
protected |
Smart pointer to the source image.
Definition at line 158 of file itkLineConstIterator.h.
|
protected |
Definition at line 181 of file itkLineConstIterator.h.
|
protected |
Is the iterator at the end of its walk?
Definition at line 164 of file itkLineConstIterator.h.
|
protected |
Definition at line 169 of file itkLineConstIterator.h.
|
protected |
Variables that drive the Bresenham-Algorithm
Definition at line 174 of file itkLineConstIterator.h.
|
protected |
Definition at line 185 of file itkLineConstIterator.h.
|
protected |
Definition at line 188 of file itkLineConstIterator.h.
|
protected |
Definition at line 192 of file itkLineConstIterator.h.
|
protected |
Region type to iterate over.
Definition at line 161 of file itkLineConstIterator.h.
|
protected |
Definition at line 168 of file itkLineConstIterator.h.