#include <itkImageSliceConstIteratorWithIndex.h>

Detailed Description

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

Multi-dimensional image iterator which only walks a region.

A multi-dimensional image iterator that extends the ImageLinearConstIteratorWithIndex from iteration along lines in an image to iteration along both lines and planes (slices) within an image. A slice is defined as a 2D plane spanned by two vectors pointing along orthogonal coordinate axes. The slice orientation of the iterator is defined by specifying its two spanning axes using the methods:

SetFirstDirection(n)

SetSecondDirection(n)

itk::ImageSliceConstIteratorWithIndex::SetFirstDirection

void SetFirstDirection(unsigned int direction)

itk::ImageSliceConstIteratorWithIndex::SetSecondDirection

void SetSecondDirection(unsigned int direction)

where n is the number of the axis.

Use the following methods to move the iterator between slices:

NextSlice()

PreviousSlice()

itk::ImageSliceConstIteratorWithIndex::PreviousSlice

void PreviousSlice()

itk::ImageSliceConstIteratorWithIndex::NextSlice

void NextSlice()

To test the position of the iterator with respect to the end or beginning of the slice use the following methods:

IsAtReverseEndOfSlice()

IsAtEndOfSlice()

itk::ImageSliceConstIteratorWithIndex::IsAtEndOfSlice

bool IsAtEndOfSlice() const

itk::ImageSliceConstIteratorWithIndex::IsAtReverseEndOfSlice

bool IsAtReverseEndOfSlice() const

The following code, for example, illustrates the typical use of this iterator. For more information please see the Software Guide.

ImageSliceConstIteratorWithIndex<ImageType> it( image, image->GetRequestedRegion() );
 
it.SetFirstDirection(2);
it.SetSecondDirection(0);
 
it.GoToBegin();
while( !it.IsAtEnd() )
{
  while( !it.IsAtEndOfSlice() )
  {
    while( !it.IsAtEndOfLine() )
    {
       value = it.Get();  // it.Set() doesn't exist in the Const Iterator
       ++it;
    }
    it.NextLine();
  }
  it.NextSlice();
 }

MORE INFORMATION: For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from https://www.itk.org.

See also: ImageConstIterator; ConditionalConstIterator; ConstNeighborhoodIterator; ConstShapedNeighborhoodIterator; ConstSliceIterator; CorrespondenceDataStructureIterator; FloodFilledFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalIterator; FloodFilledSpatialFunctionConditionalConstIterator; FloodFilledSpatialFunctionConditionalIterator; ImageConstIterator; ImageConstIteratorWithIndex; ImageIterator; ImageIteratorWithIndex; ImageLinearConstIteratorWithIndex; ImageLinearIteratorWithIndex; ImageRandomConstIteratorWithIndex; ImageRandomIteratorWithIndex; ImageRegionConstIterator; ImageRegionConstIteratorWithIndex; ImageRegionExclusionConstIteratorWithIndex; ImageRegionExclusionIteratorWithIndex; ImageRegionIterator; ImageRegionIteratorWithIndex; ImageRegionReverseConstIterator; ImageRegionReverseIterator; ImageReverseConstIterator; ImageReverseIterator; ImageSliceConstIteratorWithIndex; ImageSliceIteratorWithIndex; NeighborhoodIterator; PathConstIterator; PathIterator; ShapedNeighborhoodIterator; SliceIterator; ImageConstIteratorWithIndex

Definition at line 113 of file itkImageSliceConstIteratorWithIndex.h.

Inheritance diagram for itk::ImageSliceConstIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageSliceConstIteratorWithIndex< TImage >:

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 = ImageSliceConstIteratorWithIndex

using	SizeType = typename TImage::SizeType

using	Superclass = ImageConstIteratorWithIndex< TImage >

Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
using	AccessorFunctorType = typename TImage::AccessorFunctorType

using	AccessorType = typename TImage::AccessorType

using	ImageType = TImage

using	IndexType = typename TImage::IndexType

using	IndexValueType = typename IndexType::IndexValueType

using	InternalPixelType = typename TImage::InternalPixelType

using	OffsetType = typename TImage::OffsetType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	PixelContainer = typename TImage::PixelContainer

using	PixelContainerPointer = typename PixelContainer::Pointer

using	PixelType = typename TImage::PixelType

using	RegionType = typename TImage::RegionType

using	Self = ImageConstIteratorWithIndex

using	SizeType = typename TImage::SizeType

using	SizeValueType = typename SizeType::SizeValueType

Public Member Functions
void	GoToBeginOfSlice ()

	ImageSliceConstIteratorWithIndex ()

	ImageSliceConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)

	ImageSliceConstIteratorWithIndex (const ImageType *ptr, const RegionType &region)

bool	IsAtEndOfLine () const

bool	IsAtEndOfSlice () const

bool	IsAtReverseEndOfLine () const

bool	IsAtReverseEndOfSlice () const

void	NextLine ()

void	NextSlice ()

Self &	operator++ ()

Self &	operator-- ()

void	PreviousLine ()

void	PreviousSlice ()

void	SetFirstDirection (unsigned int direction)

void	SetSecondDirection (unsigned int direction)

Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType	Get () const

const IndexType &	GetIndex () const

const RegionType &	GetRegion () const

void	GoToBegin ()

void	GoToReverseBegin ()

	ImageConstIteratorWithIndex ()=default

	ImageConstIteratorWithIndex (const Self &it)

	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)

bool	IsAtEnd () const

bool	IsAtReverseEnd () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

bool	operator< (const Self &it) const

bool	operator<= (const Self &it) const

Self &	operator= (const Self &it)

bool	operator== (const Self &it) const

bool	operator> (const Self &it) const

bool	operator>= (const Self &it) const

bool	Remaining ()

const PixelType &	Value () const

virtual	~ImageConstIteratorWithIndex ()=default

void	SetIndex (const IndexType &ind)

Private Attributes
unsigned int	m_Direction_A

unsigned int	m_Direction_B

SizeValueType	m_LineJump

SizeValueType	m_PixelJump

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int	GetImageDimension ()

Static Public Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int	ImageDimension = TImage::ImageDimension

Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
const InternalPixelType *	m_Begin { nullptr }

IndexType	m_BeginIndex { { 0 } }

const InternalPixelType *	m_End { nullptr }

IndexType	m_EndIndex { { 0 } }

TImage::ConstWeakPointer	m_Image {}

OffsetValueType	m_OffsetTable [ImageDimension+1] {}

AccessorType	m_PixelAccessor {}

AccessorFunctorType	m_PixelAccessorFunctor {}

const InternalPixelType *	m_Position { nullptr }

IndexType	m_PositionIndex { { 0 } }

RegionType	m_Region {}

bool	m_Remaining { false }

Member Typedef Documentation

◆ AccessorType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::AccessorType = typename TImage::AccessorType

Accessor type that converts data between internal and external representations.

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

◆ ImageType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::ImageType = TImage

Image type alias support

Definition at line 116 of file itkImageConstIteratorWithIndex.h.

◆ IndexType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::IndexType = typename TImage::IndexType

Index type alias support

Definition at line 105 of file itkImageConstIteratorWithIndex.h.

◆ InternalPixelType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::InternalPixelType = typename TImage::InternalPixelType

Internal Pixel Type

Definition at line 125 of file itkImageConstIteratorWithIndex.h.

◆ OffsetType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::OffsetType = typename TImage::OffsetType

Type of the Offset taken from the image

Definition at line 136 of file itkImageConstIteratorWithIndex.h.

◆ PixelContainer

template<typename TImage >

using itk::ImageConstIteratorWithIndex< 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 121 of file itkImageConstIteratorWithIndex.h.

◆ PixelContainerPointer

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::PixelContainerPointer = typename PixelContainer::Pointer

Definition at line 122 of file itkImageConstIteratorWithIndex.h.

◆ PixelType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::PixelType = typename TImage::PixelType

External Pixel Type

Definition at line 128 of file itkImageConstIteratorWithIndex.h.

◆ RegionType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::RegionType = typename TImage::RegionType

Region type alias support

Definition at line 113 of file itkImageConstIteratorWithIndex.h.

◆ Self

template<typename TImage >

using itk::ImageSliceConstIteratorWithIndex< TImage >::Self = ImageSliceConstIteratorWithIndex

Standard class type aliases.

Definition at line 117 of file itkImageSliceConstIteratorWithIndex.h.

◆ SizeType

template<typename TImage >

using itk::ImageConstIteratorWithIndex< TImage >::SizeType = typename TImage::SizeType

Size type alias support

Definition at line 109 of file itkImageConstIteratorWithIndex.h.

◆ Superclass

template<typename TImage >

using itk::ImageSliceConstIteratorWithIndex< TImage >::Superclass = ImageConstIteratorWithIndex<TImage>

Definition at line 118 of file itkImageSliceConstIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ ImageSliceConstIteratorWithIndex() [1/3]

template<typename TImage >

itk::ImageSliceConstIteratorWithIndex< TImage >::ImageSliceConstIteratorWithIndex ( )

inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 133 of file itkImageSliceConstIteratorWithIndex.h.

◆ ImageSliceConstIteratorWithIndex() [2/3]

template<typename TImage >

itk::ImageSliceConstIteratorWithIndex< TImage >::ImageSliceConstIteratorWithIndex	(	const ImageType *	ptr,
		const RegionType &	region
	)

inline

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.

Definition at line 139 of file itkImageSliceConstIteratorWithIndex.h.

◆ ImageSliceConstIteratorWithIndex() [3/3]

template<typename TImage >

itk::ImageSliceConstIteratorWithIndex< TImage >::ImageSliceConstIteratorWithIndex ( const ImageConstIteratorWithIndex< TImage > & it )

inline

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

Definition at line 153 of file itkImageSliceConstIteratorWithIndex.h.

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

Member Function Documentation

◆ GoToBeginOfSlice()

template<typename TImage >

void itk::ImageSliceConstIteratorWithIndex< TImage >::GoToBeginOfSlice ( )

Go to the first pixel of the current slice

◆ IsAtEndOfLine()

template<typename TImage >

bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtEndOfLine ( ) const

Test if the index is at the end of line

◆ IsAtEndOfSlice()

template<typename TImage >

bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtEndOfSlice ( ) const

Test if the index is at the end of the slice

◆ IsAtReverseEndOfLine()

template<typename TImage >

bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtReverseEndOfLine ( ) const

Test if the index is at the begin of line

◆ IsAtReverseEndOfSlice()

template<typename TImage >

bool itk::ImageSliceConstIteratorWithIndex< TImage >::IsAtReverseEndOfSlice ( ) const

Test if the index is at the begin of the slice

◆ NextLine()

template<typename TImage >

void itk::ImageSliceConstIteratorWithIndex< TImage >::NextLine ( )

Go to the next line

See also: operator++; EndOfLine; End; NextSlice

◆ NextSlice()

template<typename TImage >

void itk::ImageSliceConstIteratorWithIndex< TImage >::NextSlice ( )

Go to the next slice

See also: operator++; EndOfLine; End

◆ operator++()

template<typename TImage >

Self & itk::ImageSliceConstIteratorWithIndex< TImage >::operator++ ( )

inline

Increment (prefix) the selected dimension. No bounds checking is performed.

See also: operator--; GetIndex

◆ operator--()

template<typename TImage >

Self & itk::ImageSliceConstIteratorWithIndex< TImage >::operator-- ( )

inline

Decrement (prefix) the selected dimension. No bounds checking is performed.

See also: operator++; GetIndex

◆ PreviousLine()

template<typename TImage >

void itk::ImageSliceConstIteratorWithIndex< TImage >::PreviousLine ( )

Go to the next line

See also: operator--; BeginOfLine; BeginOfSlice; Begin

◆ PreviousSlice()

template<typename TImage >

void itk::ImageSliceConstIteratorWithIndex< TImage >::PreviousSlice ( )

Go to the next slice

See also: operator--; BeginOfLine; BeginOfSlice; Begin

◆ SetFirstDirection()

template<typename TImage >

void itk::ImageSliceConstIteratorWithIndex< TImage >::SetFirstDirection ( unsigned int direction )

Set the fastest direction of movement

◆ SetSecondDirection()

template<typename TImage >

void itk::ImageSliceConstIteratorWithIndex< TImage >::SetSecondDirection ( unsigned int direction )

Set the second fastest direction of movement

Member Data Documentation

◆ m_Direction_A

template<typename TImage >

unsigned int itk::ImageSliceConstIteratorWithIndex< TImage >::m_Direction_A

private

Definition at line 221 of file itkImageSliceConstIteratorWithIndex.h.

◆ m_Direction_B

template<typename TImage >

unsigned int itk::ImageSliceConstIteratorWithIndex< TImage >::m_Direction_B

private

Definition at line 222 of file itkImageSliceConstIteratorWithIndex.h.

◆ m_LineJump

template<typename TImage >

SizeValueType itk::ImageSliceConstIteratorWithIndex< TImage >::m_LineJump

private

Definition at line 220 of file itkImageSliceConstIteratorWithIndex.h.

◆ m_PixelJump

template<typename TImage >

SizeValueType itk::ImageSliceConstIteratorWithIndex< TImage >::m_PixelJump

private

Definition at line 219 of file itkImageSliceConstIteratorWithIndex.h.

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

itkImageSliceConstIteratorWithIndex.h

Detailed Description

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AccessorType

◆ ImageType

◆ IndexType

◆ InternalPixelType

◆ OffsetType

◆ PixelContainer

◆ PixelContainerPointer

◆ PixelType

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageSliceConstIteratorWithIndex() [1/3]

◆ ImageSliceConstIteratorWithIndex() [2/3]

◆ ImageSliceConstIteratorWithIndex() [3/3]

Member Function Documentation

◆ GoToBeginOfSlice()

◆ IsAtEndOfLine()

◆ IsAtEndOfSlice()

◆ IsAtReverseEndOfLine()

◆ IsAtReverseEndOfSlice()

◆ NextLine()

◆ NextSlice()

◆ operator++()

◆ operator--()

◆ PreviousLine()

◆ PreviousSlice()

◆ SetFirstDirection()

◆ SetSecondDirection()

Member Data Documentation

◆ m_Direction_A

◆ m_Direction_B

◆ m_LineJump

◆ m_PixelJump