#include <itkIndexRange.h>

Detailed Description

template<unsigned int VDimension, bool VBeginAtZero>
class itk::IndexRange< VDimension, VBeginAtZero >

Modern C++11 range, supporting efficient iteration over the indices of an image grid space.

The following example prints all indices of an 2-D grid space of size 2x3.

constexpr unsigned int Dimension = 2;
const Size<Dimension> size = { {2, 3} };
const ZeroBasedIndexRange<Dimension> indexRange{ size };
 
for (const Index<Dimension> index : indexRange)
{
  std::cout << index;
}
// Output: "[0, 0][1, 0][0, 1][1, 1][0, 2][1, 2]"

The indices from IndexRange can also be used as consecutive locations of a ShapedImageNeighborhoodRange, for example:

for (const auto index : indexRange)
{
  shapedImageNeighborhoodRange.SetLocation(index);
 
  for (const PixelType neighborPixel : shapedImageNeighborhoodRange)
  {
    // Process neighbor pixel...
  }
}

IndexRange is designed to conform to Standard C++ Iterator requirements, so that it can be used in range-based for loop, and its iterators can be passed to Standard C++ algorithms.

Author: Niels Dekker, LKEB, Leiden University Medical Center

See also: ShapedImageNeighborhoodRange

Examples: SphinxExamples/src/Core/Common/ImageBufferAndIndexRange/Code.cxx.

Definition at line 78 of file itkIndexRange.h.

Classes
class	const_iterator

Public Types
using	const_reverse_iterator = std::reverse_iterator< const_iterator >

using	IndexType = Index< VDimension >

using	iterator = const_iterator

using	reverse_iterator = std::reverse_iterator< iterator >

using	SizeType = Size< VDimension >

Public Member Functions
constexpr iterator	begin () const noexcept

constexpr const_iterator	cbegin () const noexcept

constexpr const_iterator	cend () const noexcept

const_reverse_iterator	crbegin () const noexcept

const_reverse_iterator	crend () const noexcept

constexpr bool	empty () const noexcept

	IndexRange ()=default

constexpr	IndexRange (const SizeType &gridSize)

reverse_iterator	rbegin () const noexcept

reverse_iterator	rend () const noexcept

constexpr vcl_size_t	size () const noexcept


template<bool VIsSubstitutionFailure = VBeginAtZero, typename TVoid = std::enable_if_t<!VIsSubstitutionFailure>>
	IndexRange (const ImageRegion< VDimension > &imageRegion)


constexpr iterator	end () const noexcept

Static Public Attributes
static constexpr unsigned int	Dimension = VDimension

Private Types
using	MinIndexType = typename iterator::MinIndexType

Static Private Member Functions
static constexpr IndexType	CalculateMaxIndex (const MinIndexType &minIndex, const SizeType &size)

Private Attributes
IndexType	m_MaxIndex = IndexType::Filled(-1)

MinIndexType	m_MinIndex {}

Member Typedef Documentation

◆ const_reverse_iterator

template<unsigned int VDimension, bool VBeginAtZero>

using itk::IndexRange< VDimension, VBeginAtZero >::const_reverse_iterator = std::reverse_iterator<const_iterator>

Definition at line 294 of file itkIndexRange.h.

◆ IndexType

template<unsigned int VDimension, bool VBeginAtZero>

using itk::IndexRange< VDimension, VBeginAtZero >::IndexType = Index<VDimension>

Definition at line 83 of file itkIndexRange.h.

◆ iterator

template<unsigned int VDimension, bool VBeginAtZero>

using itk::IndexRange< VDimension, VBeginAtZero >::iterator = const_iterator

Definition at line 292 of file itkIndexRange.h.

◆ MinIndexType

template<unsigned int VDimension, bool VBeginAtZero>

using itk::IndexRange< VDimension, VBeginAtZero >::MinIndexType = typename iterator::MinIndexType

private

Definition at line 424 of file itkIndexRange.h.

◆ reverse_iterator

template<unsigned int VDimension, bool VBeginAtZero>

using itk::IndexRange< VDimension, VBeginAtZero >::reverse_iterator = std::reverse_iterator<iterator>

Definition at line 293 of file itkIndexRange.h.

◆ SizeType

template<unsigned int VDimension, bool VBeginAtZero>

using itk::IndexRange< VDimension, VBeginAtZero >::SizeType = Size<VDimension>

Definition at line 82 of file itkIndexRange.h.

Constructor & Destructor Documentation

◆ IndexRange() [1/3]

template<unsigned int VDimension, bool VBeginAtZero>

itk::IndexRange< VDimension, VBeginAtZero >::IndexRange ( )

default

Explicitly defaulted default-constructor. Constructs an empty range.

Note: The other five "special member functions" (copy-constructor, copy-assignment operator, move-constructor, move-assignment operator, and destructor) are implicitly defaulted, following the C++ "Rule of Zero".

◆ IndexRange() [2/3]

template<unsigned int VDimension, bool VBeginAtZero>

constexpr itk::IndexRange< VDimension, VBeginAtZero >::IndexRange ( const SizeType & gridSize )

inlineexplicitconstexpr

Constructs a range of indices for the specified grid size.

Definition at line 306 of file itkIndexRange.h.

◆ IndexRange() [3/3]

template<unsigned int VDimension, bool VBeginAtZero>

template<bool VIsSubstitutionFailure = VBeginAtZero, typename TVoid = std::enable_if_t<!VIsSubstitutionFailure>>

itk::IndexRange< VDimension, VBeginAtZero >::IndexRange ( const ImageRegion< VDimension > & imageRegion )

inlineexplicit

Constructs a range of indices for the specified image region.

Note: This function is unavailable when VBeginAtZero is true (in case there is a substitution failure, and C++ "SFINAE" kicks in).

Definition at line 320 of file itkIndexRange.h.

Member Function Documentation

◆ begin()

template<unsigned int VDimension, bool VBeginAtZero>

constexpr iterator itk::IndexRange< VDimension, VBeginAtZero >::begin ( ) const

inlineconstexprnoexcept

Returns an iterator to the first index.

Definition at line 338 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::m_MaxIndex, and itk::IndexRange< VDimension, VBeginAtZero >::m_MinIndex.

Referenced by itk::IndexRange< VDimension, VBeginAtZero >::cbegin(), and itk::IndexRange< VDimension, VBeginAtZero >::rend().

◆ CalculateMaxIndex()

template<unsigned int VDimension, bool VBeginAtZero>

static constexpr IndexType itk::IndexRange< VDimension, VBeginAtZero >::CalculateMaxIndex	(	const MinIndexType &	minIndex,
		const SizeType &	size
	)

inlinestaticconstexprprivate

Definition at line 427 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::size().

◆ cbegin()

template<unsigned int VDimension, bool VBeginAtZero>

constexpr const_iterator itk::IndexRange< VDimension, VBeginAtZero >::cbegin ( ) const

inlineconstexprnoexcept

Returns a const iterator to the first index. Provides only read-only access to the index data.

Definition at line 356 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::begin().

◆ cend()

template<unsigned int VDimension, bool VBeginAtZero>

constexpr const_iterator itk::IndexRange< VDimension, VBeginAtZero >::cend ( ) const

inlineconstexprnoexcept

Returns a const 'end iterator' for this range.

Definition at line 363 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::end().

◆ crbegin()

template<unsigned int VDimension, bool VBeginAtZero>

const_reverse_iterator itk::IndexRange< VDimension, VBeginAtZero >::crbegin ( ) const

inlinenoexcept

Returns a const reverse 'begin iterator' for this range.

Definition at line 384 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::rbegin().

◆ crend()

template<unsigned int VDimension, bool VBeginAtZero>

const_reverse_iterator itk::IndexRange< VDimension, VBeginAtZero >::crend ( ) const

inlinenoexcept

Returns a const reverse 'end iterator' for this range.

Definition at line 391 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::rend().

◆ empty()

template<unsigned int VDimension, bool VBeginAtZero>

constexpr bool itk::IndexRange< VDimension, VBeginAtZero >::empty ( ) const

inlineconstexprnoexcept

Tells whether the range is empty.

Definition at line 413 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::m_MaxIndex, and itk::IndexRange< VDimension, VBeginAtZero >::m_MinIndex.

◆ end()

template<unsigned int VDimension, bool VBeginAtZero>

constexpr iterator itk::IndexRange< VDimension, VBeginAtZero >::end ( ) const

inlineconstexprnoexcept

Returns an 'end iterator' for this range.

Definition at line 345 of file itkIndexRange.h.

References itk::Index< VDimension >::back(), itk::IndexRange< VDimension, VBeginAtZero >::m_MaxIndex, and itk::IndexRange< VDimension, VBeginAtZero >::m_MinIndex.

Referenced by itk::IndexRange< VDimension, VBeginAtZero >::cend(), and itk::IndexRange< VDimension, VBeginAtZero >::rbegin().

◆ rbegin()

template<unsigned int VDimension, bool VBeginAtZero>

reverse_iterator itk::IndexRange< VDimension, VBeginAtZero >::rbegin ( ) const

inlinenoexcept

Returns a reverse 'begin iterator' for this range.

Definition at line 370 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::end().

Referenced by itk::IndexRange< VDimension, VBeginAtZero >::crbegin().

◆ rend()

template<unsigned int VDimension, bool VBeginAtZero>

reverse_iterator itk::IndexRange< VDimension, VBeginAtZero >::rend ( ) const

inlinenoexcept

Returns a reverse 'end iterator' for this range.

Definition at line 377 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::begin().

Referenced by itk::IndexRange< VDimension, VBeginAtZero >::crend().

◆ size()

template<unsigned int VDimension, bool VBeginAtZero>

constexpr vcl_size_t itk::IndexRange< VDimension, VBeginAtZero >::size ( ) const

inlineconstexprnoexcept

Returns the size of the range, that is the number of indices.

Definition at line 399 of file itkIndexRange.h.

References itk::IndexRange< VDimension, VBeginAtZero >::m_MaxIndex, and itk::IndexRange< VDimension, VBeginAtZero >::m_MinIndex.

Referenced by itk::IndexRange< VDimension, VBeginAtZero >::CalculateMaxIndex().

Member Data Documentation

◆ Dimension

template<unsigned int VDimension, bool VBeginAtZero>

constexpr unsigned int itk::IndexRange< VDimension, VBeginAtZero >::Dimension = VDimension

staticconstexpr

Definition at line 81 of file itkIndexRange.h.

◆ m_MaxIndex

template<unsigned int VDimension, bool VBeginAtZero>

IndexType itk::IndexRange< VDimension, VBeginAtZero >::m_MaxIndex = IndexType::Filled(-1)

private

Definition at line 460 of file itkIndexRange.h.

Referenced by itk::IndexRange< VDimension, VBeginAtZero >::begin(), itk::IndexRange< VDimension, VBeginAtZero >::empty(), itk::IndexRange< VDimension, VBeginAtZero >::end(), and itk::IndexRange< VDimension, VBeginAtZero >::size().

◆ m_MinIndex

template<unsigned int VDimension, bool VBeginAtZero>

MinIndexType itk::IndexRange< VDimension, VBeginAtZero >::m_MinIndex {}

private

Definition at line 457 of file itkIndexRange.h.

Referenced by itk::IndexRange< VDimension, VBeginAtZero >::begin(), itk::IndexRange< VDimension, VBeginAtZero >::empty(), itk::IndexRange< VDimension, VBeginAtZero >::end(), and itk::IndexRange< VDimension, VBeginAtZero >::size().

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

itkIndexRange.h

Detailed Description

template<unsigned int VDimension, bool VBeginAtZero> class itk::IndexRange< VDimension, VBeginAtZero >

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Types

Static Private Member Functions

Private Attributes

Member Typedef Documentation

◆ const_reverse_iterator

◆ IndexType

◆ iterator

◆ MinIndexType

◆ reverse_iterator

◆ SizeType

Constructor & Destructor Documentation

◆ IndexRange() [1/3]

◆ IndexRange() [2/3]

◆ IndexRange() [3/3]

Member Function Documentation

◆ begin()

◆ CalculateMaxIndex()

◆ cbegin()

◆ cend()

◆ crbegin()

◆ crend()

◆ empty()

◆ end()

◆ rbegin()

◆ rend()

◆ size()

Member Data Documentation

◆ Dimension

◆ m_MaxIndex

◆ m_MinIndex

template<unsigned int VDimension, bool VBeginAtZero>
class itk::IndexRange< VDimension, VBeginAtZero >